Cisco-IOS-XR-man-ipsla-cfg API API Reference
API generated from Cisco-IOS-XR-man-ipsla-cfg@2015-11-09.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
Key  Mandatory  OptionalPaths
IPSLA - Update
Update operation of resource: ipsla
ipslabody object
Request Content-Types: application/json
Request Example
{ "timeout": "integer"
}, {
"local-address": "string", {
"port": "string"
}
]
}
}
]
}
}
}
}, { "create": [ null ]
}, "create": [ null ]
}, "create": [ null ]
}, "create": [ null ]
}
},
"monitor-id": "integer"
}
]
}, { "ttl": "integer",
"vrf": "string"
}, "request": "integer"
}, "frequency": "integer",
"type": "string"
},
"retry": "integer"
},
"create": [ null ], "limit": "integer",
"timeout": "integer"
},
"scan-period": "integer", "maximum-lsp-selector": "string", "bitmap-size": "integer"
},
"retry": "integer",
"timeout": "integer",
"interval": "integer"
}
},
"ttl": "integer",
"vrf": "string"
}
},
"monitor-id": "integer"
}
]
}, {
"frequency": "integer", "hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"period": "integer",
"monitor-id": "integer"
}
]
}
}, "low-memory": "integer", "key-chain": "string"
}, "disable": [ null ]
}
}, "inactivity-timer": "integer",
"port": "string"
}, {
"triggered-op-id": "integer",
"operation-id": "integer"
}
]
}, }
}
Successful operation
Internal Error
Response Content-Types: application/json
IPSLA - Create
Create operation of resource: ipsla
ipslabody object
Request Content-Types: application/json
Request Example
{ "timeout": "integer"
}, {
"local-address": "string", {
"port": "string"
}
]
}
}
]
}
}
}
}, { "create": [ null ]
}, "create": [ null ]
}, "create": [ null ]
}, "create": [ null ]
}
},
"monitor-id": "integer"
}
]
}, { "ttl": "integer",
"vrf": "string"
}, "request": "integer"
}, "frequency": "integer",
"type": "string"
},
"retry": "integer"
},
"create": [ null ], "limit": "integer",
"timeout": "integer"
},
"scan-period": "integer", "maximum-lsp-selector": "string", "bitmap-size": "integer"
},
"retry": "integer",
"timeout": "integer",
"interval": "integer"
}
},
"ttl": "integer",
"vrf": "string"
}
},
"monitor-id": "integer"
}
]
}, {
"frequency": "integer", "hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"period": "integer",
"monitor-id": "integer"
}
]
}
}, "low-memory": "integer", "key-chain": "string"
}, "disable": [ null ]
}
}, "inactivity-timer": "integer",
"port": "string"
}, {
"triggered-op-id": "integer",
"operation-id": "integer"
}
]
}, }
}
Successful operation
Internal Error
Response Content-Types: application/json
IPSLA - Delete
Delete operation of resource: ipsla
Successful operation
Internal Error
Response Content-Types: application/json
IPSLA - Retrieve
Retrieve operation of resource: ipsla
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "timeout": "integer"
}, {
"local-address": "string", {
"port": "string"
}
]
}
}
]
}
}
}
}, { "create": [ null ]
}, "create": [ null ]
}, "create": [ null ]
}, "create": [ null ]
}
},
"monitor-id": "integer"
}
]
}, { "ttl": "integer",
"vrf": "string"
}, "request": "integer"
}, "frequency": "integer",
"type": "string"
},
"retry": "integer"
},
"create": [ null ], "limit": "integer",
"timeout": "integer"
},
"scan-period": "integer", "maximum-lsp-selector": "string", "bitmap-size": "integer"
},
"retry": "integer",
"timeout": "integer",
"interval": "integer"
}
},
"ttl": "integer",
"vrf": "string"
}
},
"monitor-id": "integer"
}
]
}, {
"frequency": "integer", "hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"period": "integer",
"monitor-id": "integer"
}
]
}
}, "low-memory": "integer", "key-chain": "string"
}, "disable": [ null ]
}
}, "inactivity-timer": "integer",
"port": "string"
}, {
"triggered-op-id": "integer",
"operation-id": "integer"
}
]
}, }
}
COMMON - Update
Update operation of resource: common
commonbody object
Successful operation
Internal Error
Response Content-Types: application/json
COMMON - Create
Create operation of resource: common
commonbody object
Successful operation
Internal Error
Response Content-Types: application/json
COMMON - Delete
Delete operation of resource: common
Successful operation
Internal Error
Response Content-Types: application/json
COMMON - Retrieve
Retrieve operation of resource: common
HARDWARE-TIMESTAMP - Update
Update operation of resource: hardware-timestamp
hardware-timestampbody object
Request Content-Types: application/json
Request Example
{
"disable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
HARDWARE-TIMESTAMP - Create
Create operation of resource: hardware-timestamp
hardware-timestampbody object
Request Content-Types: application/json
Request Example
{
"disable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
HARDWARE-TIMESTAMP - Delete
Delete operation of resource: hardware-timestamp
Successful operation
Internal Error
Response Content-Types: application/json
HARDWARE-TIMESTAMP - Retrieve
Retrieve operation of resource: hardware-timestamp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"disable": [ null ]
}
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
Request Content-Types: application/json
Request Example
{
"key-chain": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
Request Content-Types: application/json
Request Example
{
"key-chain": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"key-chain": "string"
}
MPLS-LSP-MONITOR - Update
Update operation of resource: mpls-lsp-monitor
mpls-lsp-monitorbody object
Request Content-Types: application/json
Request Example
{ { "create": [ null ]
}, "create": [ null ]
}, "create": [ null ]
}, "create": [ null ]
}
},
"monitor-id": "integer"
}
]
}, { "ttl": "integer",
"vrf": "string"
}, "request": "integer"
}, "frequency": "integer",
"type": "string"
},
"retry": "integer"
},
"create": [ null ], "limit": "integer",
"timeout": "integer"
},
"scan-period": "integer", "maximum-lsp-selector": "string", "bitmap-size": "integer"
},
"retry": "integer",
"timeout": "integer",
"interval": "integer"
}
},
"ttl": "integer",
"vrf": "string"
}
},
"monitor-id": "integer"
}
]
}, {
"frequency": "integer", "hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"period": "integer",
"monitor-id": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-MONITOR - Create
Create operation of resource: mpls-lsp-monitor
mpls-lsp-monitorbody object
Request Content-Types: application/json
Request Example
{ { "create": [ null ]
}, "create": [ null ]
}, "create": [ null ]
}, "create": [ null ]
}
},
"monitor-id": "integer"
}
]
}, { "ttl": "integer",
"vrf": "string"
}, "request": "integer"
}, "frequency": "integer",
"type": "string"
},
"retry": "integer"
},
"create": [ null ], "limit": "integer",
"timeout": "integer"
},
"scan-period": "integer", "maximum-lsp-selector": "string", "bitmap-size": "integer"
},
"retry": "integer",
"timeout": "integer",
"interval": "integer"
}
},
"ttl": "integer",
"vrf": "string"
}
},
"monitor-id": "integer"
}
]
}, {
"frequency": "integer", "hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"period": "integer",
"monitor-id": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-MONITOR - Delete
Delete operation of resource: mpls-lsp-monitor
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-MONITOR - Retrieve
Retrieve operation of resource: mpls-lsp-monitor
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "create": [ null ]
}, "create": [ null ]
}, "create": [ null ]
}, "create": [ null ]
}
},
"monitor-id": "integer"
}
]
}, { "ttl": "integer",
"vrf": "string"
}, "request": "integer"
}, "frequency": "integer",
"type": "string"
},
"retry": "integer"
},
"create": [ null ], "limit": "integer",
"timeout": "integer"
},
"scan-period": "integer", "maximum-lsp-selector": "string", "bitmap-size": "integer"
},
"retry": "integer",
"timeout": "integer",
"interval": "integer"
}
},
"ttl": "integer",
"vrf": "string"
}
},
"monitor-id": "integer"
}
]
}, {
"frequency": "integer", "hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"period": "integer",
"monitor-id": "integer"
}
]
}
}
REACTIONS - Update
Update operation of resource: reactions
reactionsbody object
Request Content-Types: application/json
Request Example
{ { "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTIONS - Create
Create operation of resource: reactions
reactionsbody object
Request Content-Types: application/json
Request Example
{ { "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTIONS - Delete
Delete operation of resource: reactions
Successful operation
Internal Error
Response Content-Types: application/json
REACTIONS - Retrieve
Retrieve operation of resource: reactions
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
]
}
REACTION - Update
Update operation of resource: reaction
reactionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTION - Create
Create operation of resource: reaction
reactionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTION - Delete
Delete operation of resource: reaction
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
REACTION - Retrieve
Retrieve operation of resource: reaction
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
CONDITION - Update
Update operation of resource: condition
conditionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONDITION - Create
Create operation of resource: condition
conditionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONDITION - Delete
Delete operation of resource: condition
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
CONDITION - Retrieve
Retrieve operation of resource: condition
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
}
LPD-TREE-TRACE - Update
Update operation of resource: lpd-tree-trace
lpd-tree-tracebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"create": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
LPD-TREE-TRACE - Create
Create operation of resource: lpd-tree-trace
lpd-tree-tracebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"create": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
LPD-TREE-TRACE - Delete
Delete operation of resource: lpd-tree-trace
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
LPD-TREE-TRACE - Retrieve
Retrieve operation of resource: lpd-tree-trace
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"create": [ null ]
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"trigger": [ null ],
"logging": [ null ]
}
TIMEOUT - Update
Update operation of resource: timeout
timeoutbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"create": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUT - Create
Create operation of resource: timeout
timeoutbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"create": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUT - Delete
Delete operation of resource: timeout
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUT - Retrieve
Retrieve operation of resource: timeout
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"create": [ null ]
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"trigger": [ null ],
"logging": [ null ]
}
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
LPD-GROUP - Update
Update operation of resource: lpd-group
lpd-groupbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"create": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
LPD-GROUP - Create
Create operation of resource: lpd-group
lpd-groupbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"create": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
LPD-GROUP - Delete
Delete operation of resource: lpd-group
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
LPD-GROUP - Retrieve
Retrieve operation of resource: lpd-group
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"create": [ null ]
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"trigger": [ null ],
"logging": [ null ]
}
CONNECTION-LOSS - Update
Update operation of resource: connection-loss
connection-lossbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"create": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTION-LOSS - Create
Create operation of resource: connection-loss
connection-lossbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"create": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTION-LOSS - Delete
Delete operation of resource: connection-loss
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTION-LOSS - Retrieve
Retrieve operation of resource: connection-loss
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"create": [ null ]
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"trigger": [ null ],
"logging": [ null ]
}
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
SCHEDULES - Update
Update operation of resource: schedules
schedulesbody object
Request Content-Types: application/json
Request Example
{ {
"ageout": "integer",
"life": "string",
"recurring": [ null ], "hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"operation-id": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULES - Create
Create operation of resource: schedules
schedulesbody object
Request Content-Types: application/json
Request Example
{ {
"ageout": "integer",
"life": "string",
"recurring": [ null ], "hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"operation-id": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULES - Delete
Delete operation of resource: schedules
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULES - Retrieve
Retrieve operation of resource: schedules
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"ageout": "integer",
"life": "string",
"recurring": [ null ], "hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"operation-id": "integer"
}
]
}
SCHEDULE - Update
Update operation of resource: schedule
schedulebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"ageout": "integer",
"life": "string",
"recurring": [ null ], "hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"operation-id": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULE - Create
Create operation of resource: schedule
schedulebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"ageout": "integer",
"life": "string",
"recurring": [ null ], "hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"operation-id": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULE - Delete
Delete operation of resource: schedule
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULE - Retrieve
Retrieve operation of resource: schedule
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ageout": "integer",
"life": "string",
"recurring": [ null ], "hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"operation-id": "integer"
}
START-TIME - Update
Update operation of resource: start-time
start-timebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
START-TIME - Create
Create operation of resource: start-time
start-timebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
START-TIME - Delete
Delete operation of resource: start-time
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
START-TIME - Retrieve
Retrieve operation of resource: start-time
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
}
DEFINITIONS - Update
Update operation of resource: definitions
definitionsbody object
Request Content-Types: application/json
Request Example
{ { "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}, "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}
},
"tag": "string"
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITIONS - Create
Create operation of resource: definitions
definitionsbody object
Request Content-Types: application/json
Request Example
{ { "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}, "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}
},
"tag": "string"
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITIONS - Delete
Delete operation of resource: definitions
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITIONS - Retrieve
Retrieve operation of resource: definitions
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}, "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}
},
"tag": "string"
}
}
}
]
}
DEFINITION - Update
Update operation of resource: definition
definitionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}, "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"tag": "string"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITION - Create
Create operation of resource: definition
definitionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}, "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"tag": "string"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITION - Delete
Delete operation of resource: definition
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITION - Retrieve
Retrieve operation of resource: definition
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}, "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"tag": "string"
}
}
}
OPERATION-TYPE - Update
Update operation of resource: operation-type
operation-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}, "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION-TYPE - Create
Create operation of resource: operation-type
operation-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}, "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION-TYPE - Delete
Delete operation of resource: operation-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION-TYPE - Retrieve
Retrieve operation of resource: operation-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}, "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
}
MPLS-LSP-TRACE - Update
Update operation of resource: mpls-lsp-trace
mpls-lsp-tracebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-TRACE - Create
Create operation of resource: mpls-lsp-trace
mpls-lsp-tracebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-TRACE - Delete
Delete operation of resource: mpls-lsp-trace
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-TRACE - Retrieve
Retrieve operation of resource: mpls-lsp-trace
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
REPLY - Update
Update operation of resource: reply
replybody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"mode": "string",
"dscp-bits": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Create
Create operation of resource: reply
replybody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"mode": "string",
"dscp-bits": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Delete
Delete operation of resource: reply
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Retrieve
Retrieve operation of resource: reply
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mode": "string",
"dscp-bits": "string"
}
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
SCAN - Update
Update operation of resource: scan
scanbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"delete-factor": "integer",
"interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SCAN - Create
Create operation of resource: scan
scanbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"delete-factor": "integer",
"interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SCAN - Delete
Delete operation of resource: scan
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
SCAN - Retrieve
Retrieve operation of resource: scan
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"delete-factor": "integer",
"interval": "integer"
}
MPLS-LSP-PING - Update
Update operation of resource: mpls-lsp-ping
mpls-lsp-pingbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-PING - Create
Create operation of resource: mpls-lsp-ping
mpls-lsp-pingbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-PING - Delete
Delete operation of resource: mpls-lsp-ping
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-PING - Retrieve
Retrieve operation of resource: mpls-lsp-ping
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"request": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"request": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request": "integer"
}
PATH-DISCOVER - Update
Update operation of resource: path-discover
path-discoverbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "frequency": "integer",
"type": "string"
},
"retry": "integer"
},
"create": [ null ], "limit": "integer",
"timeout": "integer"
},
"scan-period": "integer", "maximum-lsp-selector": "string", "bitmap-size": "integer"
},
"retry": "integer",
"timeout": "integer",
"interval": "integer"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PATH-DISCOVER - Create
Create operation of resource: path-discover
path-discoverbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "frequency": "integer",
"type": "string"
},
"retry": "integer"
},
"create": [ null ], "limit": "integer",
"timeout": "integer"
},
"scan-period": "integer", "maximum-lsp-selector": "string", "bitmap-size": "integer"
},
"retry": "integer",
"timeout": "integer",
"interval": "integer"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PATH-DISCOVER - Delete
Delete operation of resource: path-discover
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
PATH-DISCOVER - Retrieve
Retrieve operation of resource: path-discover
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "frequency": "integer",
"type": "string"
},
"retry": "integer"
},
"create": [ null ], "limit": "integer",
"timeout": "integer"
},
"scan-period": "integer", "maximum-lsp-selector": "string", "bitmap-size": "integer"
},
"retry": "integer",
"timeout": "integer",
"interval": "integer"
}
}
SESSION - Update
Update operation of resource: session
sessionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"limit": "integer",
"timeout": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Create
Create operation of resource: session
sessionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"limit": "integer",
"timeout": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Delete
Delete operation of resource: session
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Retrieve
Retrieve operation of resource: session
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"limit": "integer",
"timeout": "integer"
}
PATH - Update
Update operation of resource: path
pathbody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
PATH - Create
Create operation of resource: path
pathbody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
PATH - Delete
Delete operation of resource: path
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
PATH - Retrieve
Retrieve operation of resource: path
ID of monitor-id
Successful operation
Internal Error
SECONDARY-FREQUENCY - Update
Update operation of resource: secondary-frequency
secondary-frequencybody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"frequency": "integer",
"type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-FREQUENCY - Create
Create operation of resource: secondary-frequency
secondary-frequencybody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"frequency": "integer",
"type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-FREQUENCY - Delete
Delete operation of resource: secondary-frequency
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-FREQUENCY - Retrieve
Retrieve operation of resource: secondary-frequency
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"frequency": "integer",
"type": "string"
}
ECHO - Update
Update operation of resource: echo
echobody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ECHO - Create
Create operation of resource: echo
echobody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ECHO - Delete
Delete operation of resource: echo
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ECHO - Retrieve
Retrieve operation of resource: echo
ID of monitor-id
Successful operation
Internal Error
MULTIPATH - Update
Update operation of resource: multipath
multipathbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"bitmap-size": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
MULTIPATH - Create
Create operation of resource: multipath
multipathbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"bitmap-size": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
MULTIPATH - Delete
Delete operation of resource: multipath
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
MULTIPATH - Retrieve
Retrieve operation of resource: multipath
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bitmap-size": "integer"
}
REPLY - Update
Update operation of resource: reply
replybody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"mode": "string",
"dscp-bits": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Create
Create operation of resource: reply
replybody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"mode": "string",
"dscp-bits": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Delete
Delete operation of resource: reply
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Retrieve
Retrieve operation of resource: reply
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mode": "string",
"dscp-bits": "string"
}
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
SCAN - Update
Update operation of resource: scan
scanbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"delete-factor": "integer",
"interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SCAN - Create
Create operation of resource: scan
scanbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{
"delete-factor": "integer",
"interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SCAN - Delete
Delete operation of resource: scan
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
SCAN - Retrieve
Retrieve operation of resource: scan
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"delete-factor": "integer",
"interval": "integer"
}
OPERATION - Update
Update operation of resource: operation
operationbody object
Request Content-Types: application/json
Request Example
{ {
"triggered-op-id": "integer",
"operation-id": "integer"
}
]
}, { "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
]
}, { "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, }
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION - Create
Create operation of resource: operation
operationbody object
Request Content-Types: application/json
Request Example
{ {
"triggered-op-id": "integer",
"operation-id": "integer"
}
]
}, { "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
]
}, { "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, }
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION - Delete
Delete operation of resource: operation
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION - Retrieve
Retrieve operation of resource: operation
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"triggered-op-id": "integer",
"operation-id": "integer"
}
]
}, { "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
]
}, { "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, }
}
]
}
}
SCHEDULES - Update
Update operation of resource: schedules
schedulesbody object
Request Content-Types: application/json
Request Example
{ {
"ageout": "integer",
"life": "string",
"recurring": [ null ], "hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"operation-id": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULES - Create
Create operation of resource: schedules
schedulesbody object
Request Content-Types: application/json
Request Example
{ {
"ageout": "integer",
"life": "string",
"recurring": [ null ], "hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"operation-id": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULES - Delete
Delete operation of resource: schedules
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULES - Retrieve
Retrieve operation of resource: schedules
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"ageout": "integer",
"life": "string",
"recurring": [ null ], "hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"operation-id": "integer"
}
]
}
SCHEDULE - Update
Update operation of resource: schedule
schedulebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"ageout": "integer",
"life": "string",
"recurring": [ null ], "hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"operation-id": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULE - Create
Create operation of resource: schedule
schedulebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"ageout": "integer",
"life": "string",
"recurring": [ null ], "hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"operation-id": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULE - Delete
Delete operation of resource: schedule
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULE - Retrieve
Retrieve operation of resource: schedule
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ageout": "integer",
"life": "string",
"recurring": [ null ], "hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"operation-id": "integer"
}
START-TIME - Update
Update operation of resource: start-time
start-timebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
START-TIME - Create
Create operation of resource: start-time
start-timebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
START-TIME - Delete
Delete operation of resource: start-time
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
START-TIME - Retrieve
Retrieve operation of resource: start-time
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
}
REACTIONS - Update
Update operation of resource: reactions
reactionsbody object
Request Content-Types: application/json
Request Example
{ { "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTIONS - Create
Create operation of resource: reactions
reactionsbody object
Request Content-Types: application/json
Request Example
{ { "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTIONS - Delete
Delete operation of resource: reactions
Successful operation
Internal Error
Response Content-Types: application/json
REACTIONS - Retrieve
Retrieve operation of resource: reactions
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
]
}
REACTION - Update
Update operation of resource: reaction
reactionbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTION - Create
Create operation of resource: reaction
reactionbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTION - Delete
Delete operation of resource: reaction
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
REACTION - Retrieve
Retrieve operation of resource: reaction
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
CONDITION - Update
Update operation of resource: condition
conditionbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONDITION - Create
Create operation of resource: condition
conditionbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONDITION - Delete
Delete operation of resource: condition
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
CONDITION - Retrieve
Retrieve operation of resource: condition
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}, "thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
}
JITTER-AVERAGE-DS - Update
Update operation of resource: jitter-average-ds
jitter-average-dsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE-DS - Create
Create operation of resource: jitter-average-ds
jitter-average-dsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE-DS - Delete
Delete operation of resource: jitter-average-ds
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE-DS - Retrieve
Retrieve operation of resource: jitter-average-ds
ID of operation-id
Successful operation
Internal Error
THRESHOLD-LIMITS - Update
Update operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"upper-limit": "integer",
"lower-limit": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Create
Create operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"upper-limit": "integer",
"lower-limit": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Delete
Delete operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Retrieve
Retrieve operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"upper-limit": "integer",
"lower-limit": "integer"
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"trigger": [ null ],
"logging": [ null ]
}
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
TIMEOUT - Update
Update operation of resource: timeout
timeoutbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUT - Create
Create operation of resource: timeout
timeoutbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUT - Delete
Delete operation of resource: timeout
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUT - Retrieve
Retrieve operation of resource: timeout
ID of operation-id
Successful operation
Internal Error
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"trigger": [ null ],
"logging": [ null ]
}
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
JITTER-AVERAGE - Update
Update operation of resource: jitter-average
jitter-averagebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE - Create
Create operation of resource: jitter-average
jitter-averagebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE - Delete
Delete operation of resource: jitter-average
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE - Retrieve
Retrieve operation of resource: jitter-average
ID of operation-id
Successful operation
Internal Error
THRESHOLD-LIMITS - Update
Update operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"upper-limit": "integer",
"lower-limit": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Create
Create operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"upper-limit": "integer",
"lower-limit": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Delete
Delete operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Retrieve
Retrieve operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"upper-limit": "integer",
"lower-limit": "integer"
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"trigger": [ null ],
"logging": [ null ]
}
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
VERIFY-ERROR - Update
Update operation of resource: verify-error
verify-errorbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
VERIFY-ERROR - Create
Create operation of resource: verify-error
verify-errorbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
VERIFY-ERROR - Delete
Delete operation of resource: verify-error
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
VERIFY-ERROR - Retrieve
Retrieve operation of resource: verify-error
ID of operation-id
Successful operation
Internal Error
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"trigger": [ null ],
"logging": [ null ]
}
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
RTT - Update
Update operation of resource: rtt
rttbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
RTT - Create
Create operation of resource: rtt
rttbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
RTT - Delete
Delete operation of resource: rtt
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
RTT - Retrieve
Retrieve operation of resource: rtt
ID of operation-id
Successful operation
Internal Error
THRESHOLD-LIMITS - Update
Update operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"upper-limit": "integer",
"lower-limit": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Create
Create operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"upper-limit": "integer",
"lower-limit": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Delete
Delete operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Retrieve
Retrieve operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"upper-limit": "integer",
"lower-limit": "integer"
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"trigger": [ null ],
"logging": [ null ]
}
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
PACKET-LOSS-SD - Update
Update operation of resource: packet-loss-sd
packet-loss-sdbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PACKET-LOSS-SD - Create
Create operation of resource: packet-loss-sd
packet-loss-sdbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PACKET-LOSS-SD - Delete
Delete operation of resource: packet-loss-sd
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PACKET-LOSS-SD - Retrieve
Retrieve operation of resource: packet-loss-sd
ID of operation-id
Successful operation
Internal Error
THRESHOLD-LIMITS - Update
Update operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"upper-limit": "integer",
"lower-limit": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Create
Create operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"upper-limit": "integer",
"lower-limit": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Delete
Delete operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Retrieve
Retrieve operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"upper-limit": "integer",
"lower-limit": "integer"
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"trigger": [ null ],
"logging": [ null ]
}
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
JITTER-AVERAGE-SD - Update
Update operation of resource: jitter-average-sd
jitter-average-sdbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE-SD - Create
Create operation of resource: jitter-average-sd
jitter-average-sdbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE-SD - Delete
Delete operation of resource: jitter-average-sd
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE-SD - Retrieve
Retrieve operation of resource: jitter-average-sd
ID of operation-id
Successful operation
Internal Error
THRESHOLD-LIMITS - Update
Update operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"upper-limit": "integer",
"lower-limit": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Create
Create operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"upper-limit": "integer",
"lower-limit": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Delete
Delete operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Retrieve
Retrieve operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"upper-limit": "integer",
"lower-limit": "integer"
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"trigger": [ null ],
"logging": [ null ]
}
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
CONNECTION-LOSS - Update
Update operation of resource: connection-loss
connection-lossbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTION-LOSS - Create
Create operation of resource: connection-loss
connection-lossbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTION-LOSS - Delete
Delete operation of resource: connection-loss
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTION-LOSS - Retrieve
Retrieve operation of resource: connection-loss
ID of operation-id
Successful operation
Internal Error
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"trigger": [ null ],
"logging": [ null ]
}
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
PACKET-LOSS-DS - Update
Update operation of resource: packet-loss-ds
packet-loss-dsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PACKET-LOSS-DS - Create
Create operation of resource: packet-loss-ds
packet-loss-dsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PACKET-LOSS-DS - Delete
Delete operation of resource: packet-loss-ds
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PACKET-LOSS-DS - Retrieve
Retrieve operation of resource: packet-loss-ds
ID of operation-id
Successful operation
Internal Error
THRESHOLD-LIMITS - Update
Update operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"upper-limit": "integer",
"lower-limit": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Create
Create operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"upper-limit": "integer",
"lower-limit": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Delete
Delete operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Retrieve
Retrieve operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"upper-limit": "integer",
"lower-limit": "integer"
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"trigger": [ null ],
"logging": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"trigger": [ null ],
"logging": [ null ]
}
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
REACTION-TRIGGERS - Update
Update operation of resource: reaction-triggers
reaction-triggersbody object
Successful operation
Internal Error
Response Content-Types: application/json
REACTION-TRIGGERS - Create
Create operation of resource: reaction-triggers
reaction-triggersbody object
Successful operation
Internal Error
Response Content-Types: application/json
REACTION-TRIGGERS - Delete
Delete operation of resource: reaction-triggers
Successful operation
Internal Error
Response Content-Types: application/json
REACTION-TRIGGERS - Retrieve
Retrieve operation of resource: reaction-triggers
Successful operation
Internal Error
REACTION-TRIGGER - Update
Update operation of resource: reaction-trigger
reaction-triggerbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"triggered-op-id": "integer",
"operation-id": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTION-TRIGGER - Create
Create operation of resource: reaction-trigger
reaction-triggerbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"triggered-op-id": "integer",
"operation-id": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTION-TRIGGER - Delete
Delete operation of resource: reaction-trigger
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
REACTION-TRIGGER - Retrieve
Retrieve operation of resource: reaction-trigger
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"triggered-op-id": "integer",
"operation-id": "integer"
}
DEFINITIONS - Update
Update operation of resource: definitions
definitionsbody object
Request Content-Types: application/json
Request Example
{ { "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}, "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}
},
"tag": "string"
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITIONS - Create
Create operation of resource: definitions
definitionsbody object
Request Content-Types: application/json
Request Example
{ { "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}, "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}
},
"tag": "string"
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITIONS - Delete
Delete operation of resource: definitions
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITIONS - Retrieve
Retrieve operation of resource: definitions
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}, "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}
},
"tag": "string"
}
}
}
]
}
DEFINITION - Update
Update operation of resource: definition
definitionbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}, "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"tag": "string"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITION - Create
Create operation of resource: definition
definitionbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}, "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"tag": "string"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITION - Delete
Delete operation of resource: definition
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITION - Retrieve
Retrieve operation of resource: definition
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}, "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"tag": "string"
}
}
}
OPERATION-TYPE - Update
Update operation of resource: operation-type
operation-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}, "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION-TYPE - Create
Create operation of resource: operation-type
operation-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}, "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION-TYPE - Delete
Delete operation of resource: operation-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION-TYPE - Retrieve
Retrieve operation of resource: operation-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "request": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
}, "count": "integer",
"interval": "integer"
},
"tag": "string"
}, "request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}, "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}, "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
}
ICMP-ECHO - Update
Update operation of resource: icmp-echo
icmp-echobody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-ECHO - Create
Create operation of resource: icmp-echo
icmp-echobody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-ECHO - Delete
Delete operation of resource: icmp-echo
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-ECHO - Retrieve
Retrieve operation of resource: icmp-echo
ID of operation-id
Successful operation
Internal Error
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"request": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"request": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request": "integer"
}
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
HISTORY - Update
Update operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Create
Create operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Delete
Delete operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Retrieve
Retrieve operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
}
ENHANCED-STATS - Update
Update operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Create
Create operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Delete
Delete operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Retrieve
Retrieve operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
ENHANCED-STAT - Update
Update operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Request Content-Types: application/json
Request Example
{
"buckets": "integer",
"interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Create
Create operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Request Content-Types: application/json
Request Example
{
"buckets": "integer",
"interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Delete
Delete operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Retrieve
Retrieve operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"buckets": "integer",
"interval": "integer"
}
MPLS-LSP-PING - Update
Update operation of resource: mpls-lsp-ping
mpls-lsp-pingbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-PING - Create
Create operation of resource: mpls-lsp-ping
mpls-lsp-pingbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-PING - Delete
Delete operation of resource: mpls-lsp-ping
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-PING - Retrieve
Retrieve operation of resource: mpls-lsp-ping
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "mode": "string",
"dscp-bits": "string"
}, "request": "integer"
}, "vc-id": "integer",
"address": "string"
}
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"request": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"request": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request": "integer"
}
REPLY - Update
Update operation of resource: reply
replybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"mode": "string",
"dscp-bits": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Create
Create operation of resource: reply
replybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"mode": "string",
"dscp-bits": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Delete
Delete operation of resource: reply
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Retrieve
Retrieve operation of resource: reply
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mode": "string",
"dscp-bits": "string"
}
TARGET - Update
Update operation of resource: target
targetbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
ID of operation-id
TRAFFIC-ENGINEERING - Update
Update operation of resource: traffic-engineering
traffic-engineeringbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"tunnel": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Create
Create operation of resource: traffic-engineering
traffic-engineeringbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"tunnel": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Delete
Delete operation of resource: traffic-engineering
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Retrieve
Retrieve operation of resource: traffic-engineering
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel": "integer"
}
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
ID of operation-id
Successful operation
Internal Error
FEC-ADDRESS - Update
Update operation of resource: fec-address
fec-addressbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"mask": "string",
"address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FEC-ADDRESS - Create
Create operation of resource: fec-address
fec-addressbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"mask": "string",
"address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FEC-ADDRESS - Delete
Delete operation of resource: fec-address
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
FEC-ADDRESS - Retrieve
Retrieve operation of resource: fec-address
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mask": "string",
"address": "string"
}
PSEUDOWIRE - Update
Update operation of resource: pseudowire
pseudowirebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE - Create
Create operation of resource: pseudowire
pseudowirebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE - Delete
Delete operation of resource: pseudowire
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE - Retrieve
Retrieve operation of resource: pseudowire
ID of operation-id
Successful operation
Internal Error
TARGET-ADDRESS - Update
Update operation of resource: target-address
target-addressbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"vc-id": "integer",
"address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Create
Create operation of resource: target-address
target-addressbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"vc-id": "integer",
"address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Delete
Delete operation of resource: target-address
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vc-id": "integer",
"address": "string"
}
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
HISTORY - Update
Update operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Create
Create operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Delete
Delete operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Retrieve
Retrieve operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
}
ENHANCED-STATS - Update
Update operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Create
Create operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Delete
Delete operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Retrieve
Retrieve operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
ENHANCED-STAT - Update
Update operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Request Content-Types: application/json
Request Example
{
"buckets": "integer",
"interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Create
Create operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Request Content-Types: application/json
Request Example
{
"buckets": "integer",
"interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Delete
Delete operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Retrieve
Retrieve operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"buckets": "integer",
"interval": "integer"
}
UDP-ECHO - Update
Update operation of resource: udp-echo
udp-echobody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
UDP-ECHO - Create
Create operation of resource: udp-echo
udp-echobody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
UDP-ECHO - Delete
Delete operation of resource: udp-echo
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
UDP-ECHO - Retrieve
Retrieve operation of resource: udp-echo
ID of operation-id
Successful operation
Internal Error
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"request": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"request": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request": "integer"
}
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
HISTORY - Update
Update operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Create
Create operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Delete
Delete operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Retrieve
Retrieve operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
}
ENHANCED-STATS - Update
Update operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Create
Create operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Delete
Delete operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Retrieve
Retrieve operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
ENHANCED-STAT - Update
Update operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Request Content-Types: application/json
Request Example
{
"buckets": "integer",
"interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Create
Create operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Request Content-Types: application/json
Request Example
{
"buckets": "integer",
"interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Delete
Delete operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Retrieve
Retrieve operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"buckets": "integer",
"interval": "integer"
}
MPLS-LSP-TRACE - Update
Update operation of resource: mpls-lsp-trace
mpls-lsp-tracebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-TRACE - Create
Create operation of resource: mpls-lsp-trace
mpls-lsp-tracebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-TRACE - Delete
Delete operation of resource: mpls-lsp-trace
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-TRACE - Retrieve
Retrieve operation of resource: mpls-lsp-trace
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "mode": "string",
"dscp-bits": "string"
}, "mask": "string",
"address": "string"
}
}, "tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
TARGET - Update
Update operation of resource: target
targetbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
ID of operation-id
TRAFFIC-ENGINEERING - Update
Update operation of resource: traffic-engineering
traffic-engineeringbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"tunnel": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Create
Create operation of resource: traffic-engineering
traffic-engineeringbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"tunnel": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Delete
Delete operation of resource: traffic-engineering
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Retrieve
Retrieve operation of resource: traffic-engineering
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel": "integer"
}
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
ID of operation-id
Successful operation
Internal Error
FEC-ADDRESS - Update
Update operation of resource: fec-address
fec-addressbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"mask": "string",
"address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FEC-ADDRESS - Create
Create operation of resource: fec-address
fec-addressbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"mask": "string",
"address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FEC-ADDRESS - Delete
Delete operation of resource: fec-address
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
FEC-ADDRESS - Retrieve
Retrieve operation of resource: fec-address
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mask": "string",
"address": "string"
}
REPLY - Update
Update operation of resource: reply
replybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"mode": "string",
"dscp-bits": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Create
Create operation of resource: reply
replybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"mode": "string",
"dscp-bits": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Delete
Delete operation of resource: reply
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Retrieve
Retrieve operation of resource: reply
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mode": "string",
"dscp-bits": "string"
}
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
HISTORY - Update
Update operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Create
Create operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Delete
Delete operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Retrieve
Retrieve operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
}
UDP-JITTER - Update
Update operation of resource: udp-jitter
udp-jitterbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
UDP-JITTER - Create
Create operation of resource: udp-jitter
udp-jitterbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
UDP-JITTER - Delete
Delete operation of resource: udp-jitter
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
UDP-JITTER - Retrieve
Retrieve operation of resource: udp-jitter
ID of operation-id
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"request": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"request": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request": "integer"
}
PACKET - Update
Update operation of resource: packet
packetbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"count": "integer",
"interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
PACKET - Create
Create operation of resource: packet
packetbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"count": "integer",
"interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
PACKET - Delete
Delete operation of resource: packet
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PACKET - Retrieve
Retrieve operation of resource: packet
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "integer",
"interval": "integer"
}
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
ENHANCED-STATS - Update
Update operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Create
Create operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Delete
Delete operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Retrieve
Retrieve operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
ENHANCED-STAT - Update
Update operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Request Content-Types: application/json
Request Example
{
"buckets": "integer",
"interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Create
Create operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Request Content-Types: application/json
Request Example
{
"buckets": "integer",
"interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Delete
Delete operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Retrieve
Retrieve operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"buckets": "integer",
"interval": "integer"
}
ICMP-PATH-ECHO - Update
Update operation of resource: icmp-path-echo
icmp-path-echobody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-PATH-ECHO - Create
Create operation of resource: icmp-path-echo
icmp-path-echobody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-PATH-ECHO - Delete
Delete operation of resource: icmp-path-echo
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-PATH-ECHO - Retrieve
Retrieve operation of resource: icmp-path-echo
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}, "request": "integer"
}, "buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}
HISTORY - Update
Update operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Create
Create operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Delete
Delete operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Retrieve
Retrieve operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
}
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"request": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"request": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request": "integer"
}
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
LSR-PATH - Update
Update operation of resource: lsr-path
lsr-pathbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"node8": "string",
"node1": "string",
"node3": "string",
"node2": "string",
"node5": "string",
"node4": "string",
"node7": "string",
"node6": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LSR-PATH - Create
Create operation of resource: lsr-path
lsr-pathbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"node8": "string",
"node1": "string",
"node3": "string",
"node2": "string",
"node5": "string",
"node4": "string",
"node7": "string",
"node6": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LSR-PATH - Delete
Delete operation of resource: lsr-path
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
LSR-PATH - Retrieve
Retrieve operation of resource: lsr-path
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"node8": "string",
"node1": "string",
"node3": "string",
"node2": "string",
"node5": "string",
"node4": "string",
"node7": "string",
"node6": "string"
}
ICMP-PATH-JITTER - Update
Update operation of resource: icmp-path-jitter
icmp-path-jitterbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-PATH-JITTER - Create
Create operation of resource: icmp-path-jitter
icmp-path-jitterbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-PATH-JITTER - Delete
Delete operation of resource: icmp-path-jitter
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-PATH-JITTER - Retrieve
Retrieve operation of resource: icmp-path-jitter
ID of operation-id
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"request": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"request": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request": "integer"
}
PACKET - Update
Update operation of resource: packet
packetbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"count": "integer",
"interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
PACKET - Create
Create operation of resource: packet
packetbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"count": "integer",
"interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
PACKET - Delete
Delete operation of resource: packet
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PACKET - Retrieve
Retrieve operation of resource: packet
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"count": "integer",
"interval": "integer"
}
LSR-PATH - Update
Update operation of resource: lsr-path
lsr-pathbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"node8": "string",
"node1": "string",
"node3": "string",
"node2": "string",
"node5": "string",
"node4": "string",
"node7": "string",
"node6": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LSR-PATH - Create
Create operation of resource: lsr-path
lsr-pathbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{
"node8": "string",
"node1": "string",
"node3": "string",
"node2": "string",
"node5": "string",
"node4": "string",
"node7": "string",
"node6": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LSR-PATH - Delete
Delete operation of resource: lsr-path
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
LSR-PATH - Retrieve
Retrieve operation of resource: lsr-path
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"node8": "string",
"node1": "string",
"node3": "string",
"node2": "string",
"node5": "string",
"node4": "string",
"node7": "string",
"node6": "string"
}
RESPONDER - Update
Update operation of resource: responder
responderbody object
Request Content-Types: application/json
Request Example
{ "timeout": "integer"
}, {
"local-address": "string", {
"port": "string"
}
]
}
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RESPONDER - Create
Create operation of resource: responder
responderbody object
Request Content-Types: application/json
Request Example
{ "timeout": "integer"
}, {
"local-address": "string", {
"port": "string"
}
]
}
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RESPONDER - Delete
Delete operation of resource: responder
Successful operation
Internal Error
Response Content-Types: application/json
RESPONDER - Retrieve
Retrieve operation of resource: responder
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "timeout": "integer"
}, {
"local-address": "string", {
"port": "string"
}
]
}
}
]
}
}
}
}
TWAMP - Update
Update operation of resource: twamp
twampbody object
Request Content-Types: application/json
Request Example
{
"timeout": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TWAMP - Create
Create operation of resource: twamp
twampbody object
Request Content-Types: application/json
Request Example
{
"timeout": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TWAMP - Delete
Delete operation of resource: twamp
Successful operation
Internal Error
Response Content-Types: application/json
TWAMP - Retrieve
Retrieve operation of resource: twamp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"timeout": "integer"
}
TYPE - Update
Update operation of resource: type
typebody object
Successful operation
Internal Error
Response Content-Types: application/json
TYPE - Create
Create operation of resource: type
typebody object
Successful operation
Internal Error
Response Content-Types: application/json
TYPE - Delete
Delete operation of resource: type
Successful operation
Internal Error
Response Content-Types: application/json
TYPE - Retrieve
Retrieve operation of resource: type
Successful operation
Internal Error
UDP - Update
Update operation of resource: udp
udpbody object
Successful operation
Internal Error
Response Content-Types: application/json
UDP - Create
Create operation of resource: udp
udpbody object
Successful operation
Internal Error
Response Content-Types: application/json
UDP - Delete
Delete operation of resource: udp
Successful operation
Internal Error
Response Content-Types: application/json
UDP - Retrieve
Retrieve operation of resource: udp
ADDRESSES - Update
Update operation of resource: addresses
addressesbody object
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESSES - Create
Create operation of resource: addresses
addressesbody object
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESSES - Delete
Delete operation of resource: addresses
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESSES - Retrieve
Retrieve operation of resource: addresses
ADDRESS - Update
Update operation of resource: address
addressbody object
ID of local-address
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESS - Create
Create operation of resource: address
addressbody object
ID of local-address
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESS - Delete
Delete operation of resource: address
ID of local-address
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESS - Retrieve
Retrieve operation of resource: address
ID of local-address
PORTS - Update
Update operation of resource: ports
portsbody object
ID of local-address
Successful operation
Internal Error
Response Content-Types: application/json
PORTS - Create
Create operation of resource: ports
portsbody object
ID of local-address
Successful operation
Internal Error
Response Content-Types: application/json
PORTS - Delete
Delete operation of resource: ports
ID of local-address
Successful operation
Internal Error
Response Content-Types: application/json
PORTS - Retrieve
Retrieve operation of resource: ports
ID of local-address
Successful operation
Internal Error
PORT - Update
Update operation of resource: port
portbody object
ID of local-address
ID of port
Request Content-Types: application/json
Request Example
{
"port": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PORT - Create
Create operation of resource: port
portbody object
ID of local-address
ID of port
Request Content-Types: application/json
Request Example
{
"port": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PORT - Delete
Delete operation of resource: port
ID of local-address
ID of port
Successful operation
Internal Error
Response Content-Types: application/json
PORT - Retrieve
Retrieve operation of resource: port
ID of local-address
ID of port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string"
}
MPLS-DISCOVERY - Update
Update operation of resource: mpls-discovery
mpls-discoverybody object
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-DISCOVERY - Create
Create operation of resource: mpls-discovery
mpls-discoverybody object
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-DISCOVERY - Delete
Delete operation of resource: mpls-discovery
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-DISCOVERY - Retrieve
Retrieve operation of resource: mpls-discovery
Successful operation
Internal Error
VPN - Update
Update operation of resource: vpn
vpnbody object
Request Content-Types: application/json
Request Example
{
"interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
VPN - Create
Create operation of resource: vpn
vpnbody object
Request Content-Types: application/json
Request Example
{
"interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
VPN - Delete
Delete operation of resource: vpn
Successful operation
Internal Error
Response Content-Types: application/json
VPN - Retrieve
Retrieve operation of resource: vpn
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interval": "integer"
}
SERVER-TWAMP - Update
Update operation of resource: server-twamp
server-twampbody object
Request Content-Types: application/json
Request Example
{
"inactivity-timer": "integer",
"port": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-TWAMP - Create
Create operation of resource: server-twamp
server-twampbody object
Request Content-Types: application/json
Request Example
{
"inactivity-timer": "integer",
"port": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-TWAMP - Delete
Delete operation of resource: server-twamp
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-TWAMP - Retrieve
Retrieve operation of resource: server-twamp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"inactivity-timer": "integer",
"port": "string"
}
SNMP - Update
Update operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
ENCRYPTED-COMMUNITY-MAPS - Update
Update operation of resource: encrypted-community-maps
encrypted-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Create
Create operation of resource: encrypted-community-maps
encrypted-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Delete
Delete operation of resource: encrypted-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Retrieve
Retrieve operation of resource: encrypted-community-maps
Successful operation
Internal Error
ENCRYPTED-COMMUNITY-MAP - Update
Update operation of resource: encrypted-community-map
encrypted-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Create
Create operation of resource: encrypted-community-map
encrypted-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Delete
Delete operation of resource: encrypted-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Retrieve
Retrieve operation of resource: encrypted-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
VIEWS - Update
Update operation of resource: views
viewsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Create
Create operation of resource: views
viewsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Delete
Delete operation of resource: views
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Retrieve
Retrieve operation of resource: views
Successful operation
Internal Error
VIEW - Update
Update operation of resource: view
viewbody object
ID of view-name family
Request Content-Types: application/json
Request Example
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Create
Create operation of resource: view
viewbody object
ID of view-name family
Request Content-Types: application/json
Request Example
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Delete
Delete operation of resource: view
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Retrieve
Retrieve operation of resource: view
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
LOGGING - Update
Update operation of resource: logging
loggingbody object
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Create
Create operation of resource: logging
loggingbody object
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Delete
Delete operation of resource: logging
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Retrieve
Retrieve operation of resource: logging
Successful operation
Internal Error
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
Request Content-Types: application/json
Request Example
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
Request Content-Types: application/json
Request Example
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
ADMINISTRATION - Update
Update operation of resource: administration
administrationbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}, {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Create
Create operation of resource: administration
administrationbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}, {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Delete
Delete operation of resource: administration
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Retrieve
Retrieve operation of resource: administration
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}, {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
DEFAULT-COMMUNITIES - Update
Update operation of resource: default-communities
default-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Create
Create operation of resource: default-communities
default-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Delete
Delete operation of resource: default-communities
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Retrieve
Retrieve operation of resource: default-communities
Successful operation
Internal Error
DEFAULT-COMMUNITY - Update
Update operation of resource: default-community
default-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Create
Create operation of resource: default-community
default-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Delete
Delete operation of resource: default-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Retrieve
Retrieve operation of resource: default-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
ENCRYPTED-COMMUNITIES - Update
Update operation of resource: encrypted-communities
encrypted-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Create
Create operation of resource: encrypted-communities
encrypted-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Delete
Delete operation of resource: encrypted-communities
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-communities
Successful operation
Internal Error
ENCRYPTED-COMMUNITY - Update
Update operation of resource: encrypted-community
encrypted-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Create
Create operation of resource: encrypted-community
encrypted-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Delete
Delete operation of resource: encrypted-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
AGENT - Update
Update operation of resource: agent
agentbody object
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Create
Create operation of resource: agent
agentbody object
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Delete
Delete operation of resource: agent
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Retrieve
Retrieve operation of resource: agent
Successful operation
Internal Error
ENGINE-ID - Update
Update operation of resource: engine-id
engine-idbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Create
Create operation of resource: engine-id
engine-idbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Delete
Delete operation of resource: engine-id
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Retrieve
Retrieve operation of resource: engine-id
REMOTES - Update
Update operation of resource: remotes
remotesbody object
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Create
Create operation of resource: remotes
remotesbody object
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Delete
Delete operation of resource: remotes
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Retrieve
Retrieve operation of resource: remotes
Successful operation
Internal Error
REMOTE - Update
Update operation of resource: remote
remotebody object
ID of remote-address
Request Content-Types: application/json
Request Example
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Create
Create operation of resource: remote
remotebody object
ID of remote-address
Request Content-Types: application/json
Request Example
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Delete
Delete operation of resource: remote
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Retrieve
Retrieve operation of resource: remote
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
TRAP - Update
Update operation of resource: trap
trapbody object
Request Content-Types: application/json
Request Example
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Create
Create operation of resource: trap
trapbody object
Request Content-Types: application/json
Request Example
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Delete
Delete operation of resource: trap
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Retrieve
Retrieve operation of resource: trap
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
DROP-PACKET - Update
Update operation of resource: drop-packet
drop-packetbody object
Request Content-Types: application/json
Request Example
{
"unknown-user": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Create
Create operation of resource: drop-packet
drop-packetbody object
Request Content-Types: application/json
Request Example
{
"unknown-user": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Delete
Delete operation of resource: drop-packet
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Retrieve
Retrieve operation of resource: drop-packet
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknown-user": [ null ]
}
IPV6 - Update
Update operation of resource: ipv6
ipv6body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Create
Create operation of resource: ipv6
ipv6body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Delete
Delete operation of resource: ipv6
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Retrieve
Retrieve operation of resource: ipv6
Successful operation
Internal Error
TOS - Update
Update operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Create
Create operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Delete
Delete operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Retrieve
Retrieve operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
TOS - Update
Update operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Create
Create operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Delete
Delete operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Retrieve
Retrieve operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
SYSTEM - Update
Update operation of resource: system
systembody object
Request Content-Types: application/json
Request Example
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Create
Create operation of resource: system
systembody object
Request Content-Types: application/json
Request Example
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Delete
Delete operation of resource: system
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Retrieve
Retrieve operation of resource: system
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
TARGET - Update
Update operation of resource: target
targetbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
Successful operation
Internal Error
TARGETS - Update
Update operation of resource: targets
targetsbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Create
Create operation of resource: targets
targetsbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Delete
Delete operation of resource: targets
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Retrieve
Retrieve operation of resource: targets
Successful operation
Internal Error
TARGET - Update
Update operation of resource: target
targetbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
ID of target-list-name
Successful operation
Internal Error
VRF-NAMES - Update
Update operation of resource: vrf-names
vrf-namesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Create
Create operation of resource: vrf-names
vrf-namesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Delete
Delete operation of resource: vrf-names
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Retrieve
Retrieve operation of resource: vrf-names
ID of target-list-name
Successful operation
Internal Error
VRF-NAME - Update
Update operation of resource: vrf-name
vrf-namebody object
ID of target-list-name
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Create
Create operation of resource: vrf-name
vrf-namebody object
ID of target-list-name
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Delete
Delete operation of resource: vrf-name
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Retrieve
Retrieve operation of resource: vrf-name
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string"
}
TARGET-ADDRESSES - Update
Update operation of resource: target-addresses
target-addressesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Create
Create operation of resource: target-addresses
target-addressesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Delete
Delete operation of resource: target-addresses
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Retrieve
Retrieve operation of resource: target-addresses
ID of target-list-name
Successful operation
Internal Error
TARGET-ADDRESS - Update
Update operation of resource: target-address
target-addressbody object
ID of target-list-name
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Create
Create operation of resource: target-address
target-addressbody object
ID of target-list-name
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Delete
Delete operation of resource: target-address
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ip-address": "string"
}
NOTIFICATION - Update
Update operation of resource: notification
notificationbody object
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Create
Create operation of resource: notification
notificationbody object
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Delete
Delete operation of resource: notification
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Retrieve
Retrieve operation of resource: notification
Successful operation
Internal Error
SNMP - Update
Update operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
CORRELATOR - Update
Update operation of resource: correlator
correlatorbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}, {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Create
Create operation of resource: correlator
correlatorbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}, {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Delete
Delete operation of resource: correlator
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Retrieve
Retrieve operation of resource: correlator
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}, {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
RULES - Update
Update operation of resource: rules
rulesbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Create
Create operation of resource: rules
rulesbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Delete
Delete operation of resource: rules
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Retrieve
Retrieve operation of resource: rules
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
RULE - Update
Update operation of resource: rule
rulebody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Create
Create operation of resource: rule
rulebody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Delete
Delete operation of resource: rule
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Retrieve
Retrieve operation of resource: rule
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
ROOT-CAUSES - Update
Update operation of resource: root-causes
root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Create
Create operation of resource: root-causes
root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Delete
Delete operation of resource: root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Retrieve
Retrieve operation of resource: root-causes
ID of name
Successful operation
Internal Error
ROOT-CAUSE - Update
Update operation of resource: root-cause
root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Create
Create operation of resource: root-cause
root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Delete
Delete operation of resource: root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Retrieve
Retrieve operation of resource: root-cause
ID of name
ID of oid
Successful operation
Internal Error
VAR-BINDS - Update
Update operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Create
Create operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Delete
Delete operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Retrieve
Retrieve operation of resource: var-binds
ID of name
ID of oid
VAR-BIND - Update
Update operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Create
Create operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Delete
Delete operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Retrieve
Retrieve operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
MATCH - Update
Update operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"index": "string",
"value": "string"
}
NON-ROOT-CAUSES - Update
Update operation of resource: non-root-causes
non-root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Create
Create operation of resource: non-root-causes
non-root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Delete
Delete operation of resource: non-root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Retrieve
Retrieve operation of resource: non-root-causes
ID of name
Successful operation
Internal Error
NON-ROOT-CAUSE - Update
Update operation of resource: non-root-cause
non-root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Create
Create operation of resource: non-root-cause
non-root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Delete
Delete operation of resource: non-root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Retrieve
Retrieve operation of resource: non-root-cause
ID of name
ID of oid
Successful operation
Internal Error
VAR-BINDS - Update
Update operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Create
Create operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Delete
Delete operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Retrieve
Retrieve operation of resource: var-binds
ID of name
ID of oid
VAR-BIND - Update
Update operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Create
Create operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Delete
Delete operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Retrieve
Retrieve operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
MATCH - Update
Update operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"index": "string",
"value": "string"
}
APPLIED-TO - Update
Update operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Create
Create operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Delete
Delete operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Retrieve
Retrieve operation of resource: applied-to
ID of name
HOSTS - Update
Update operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Create
Create operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Delete
Delete operation of resource: hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Retrieve
Retrieve operation of resource: hosts
ID of name
Successful operation
Internal Error
HOST - Update
Update operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Create
Create operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Delete
Delete operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Retrieve
Retrieve operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"ip-address": "string"
}
RULE-SETS - Update
Update operation of resource: rule-sets
rule-setsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Create
Create operation of resource: rule-sets
rule-setsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Delete
Delete operation of resource: rule-sets
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Retrieve
Retrieve operation of resource: rule-sets
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
RULE-SET - Update
Update operation of resource: rule-set
rule-setbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Create
Create operation of resource: rule-set
rule-setbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Delete
Delete operation of resource: rule-set
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Retrieve
Retrieve operation of resource: rule-set
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
RULENAMES - Update
Update operation of resource: rulenames
rulenamesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Create
Create operation of resource: rulenames
rulenamesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Delete
Delete operation of resource: rulenames
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Retrieve
Retrieve operation of resource: rulenames
ID of name
Successful operation
Internal Error
RULENAME - Update
Update operation of resource: rulename
rulenamebody object
ID of name
ID of rulename
Request Content-Types: application/json
Request Example
{
"rulename": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Create
Create operation of resource: rulename
rulenamebody object
ID of name
ID of rulename
Request Content-Types: application/json
Request Example
{
"rulename": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Delete
Delete operation of resource: rulename
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Retrieve
Retrieve operation of resource: rulename
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rulename": "string"
}
APPLIED-TO - Update
Update operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Create
Create operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Delete
Delete operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Retrieve
Retrieve operation of resource: applied-to
ID of name
HOSTS - Update
Update operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Create
Create operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Delete
Delete operation of resource: hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Retrieve
Retrieve operation of resource: hosts
ID of name
Successful operation
Internal Error
HOST - Update
Update operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Create
Create operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Delete
Delete operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Retrieve
Retrieve operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"ip-address": "string"
}
BULK-STATS - Update
Update operation of resource: bulk-stats
bulk-statsbody object
Request Content-Types: application/json
Request Example
{
"memory": "integer", {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}, {
"object-list-name": "string", {
"oid": "string"
}
]
},
"type": [ null ]
}
]
}, {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Create
Create operation of resource: bulk-stats
bulk-statsbody object
Request Content-Types: application/json
Request Example
{
"memory": "integer", {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}, {
"object-list-name": "string", {
"oid": "string"
}
]
},
"type": [ null ]
}
]
}, {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Delete
Delete operation of resource: bulk-stats
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Retrieve
Retrieve operation of resource: bulk-stats
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"memory": "integer", {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}, {
"object-list-name": "string", {
"oid": "string"
}
]
},
"type": [ null ]
}
]
}, {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
SCHEMAS - Update
Update operation of resource: schemas
schemasbody object
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Create
Create operation of resource: schemas
schemasbody object
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Delete
Delete operation of resource: schemas
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Retrieve
Retrieve operation of resource: schemas
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
SCHEMA - Update
Update operation of resource: schema
schemabody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Create
Create operation of resource: schema
schemabody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Delete
Delete operation of resource: schema
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Retrieve
Retrieve operation of resource: schema
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
INSTANCE - Update
Update operation of resource: instance
instancebody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Create
Create operation of resource: instance
instancebody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Delete
Delete operation of resource: instance
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Retrieve
Retrieve operation of resource: instance
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
OBJECTS - Update
Update operation of resource: objects
objectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Create
Create operation of resource: objects
objectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Delete
Delete operation of resource: objects
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Retrieve
Retrieve operation of resource: objects
Successful operation
Internal Error
OBJECT - Update
Update operation of resource: object
objectbody object
ID of object-list-name
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Create
Create operation of resource: object
objectbody object
ID of object-list-name
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Delete
Delete operation of resource: object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Retrieve
Retrieve operation of resource: object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"oid": "string"
}
OBJECTS - Update
Update operation of resource: objects
objectsbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Create
Create operation of resource: objects
objectsbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Delete
Delete operation of resource: objects
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Retrieve
Retrieve operation of resource: objects
ID of object-list-name
Successful operation
Internal Error
OBJECT - Update
Update operation of resource: object
objectbody object
ID of object-list-name
ID of oid
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Create
Create operation of resource: object
objectbody object
ID of object-list-name
ID of oid
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Delete
Delete operation of resource: object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Retrieve
Retrieve operation of resource: object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"oid": "string"
}
TRANSFERS - Update
Update operation of resource: transfers
transfersbody object
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Create
Create operation of resource: transfers
transfersbody object
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Delete
Delete operation of resource: transfers
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Retrieve
Retrieve operation of resource: transfers
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
TRANSFER - Update
Update operation of resource: transfer
transferbody object
ID of transfer-name
Request Content-Types: application/json
Request Example
{
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Create
Create operation of resource: transfer
transferbody object
ID of transfer-name
Request Content-Types: application/json
Request Example
{
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Delete
Delete operation of resource: transfer
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Retrieve
Retrieve operation of resource: transfer
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
TRANSFER-SCHEMAS - Update
Update operation of resource: transfer-schemas
transfer-schemasbody object
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Create
Create operation of resource: transfer-schemas
transfer-schemasbody object
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Delete
Delete operation of resource: transfer-schemas
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Retrieve
Retrieve operation of resource: transfer-schemas
ID of transfer-name
Successful operation
Internal Error
TRANSFER-SCHEMA - Update
Update operation of resource: transfer-schema
transfer-schemabody object
ID of transfer-name
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Create
Create operation of resource: transfer-schema
transfer-schemabody object
ID of transfer-name
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Delete
Delete operation of resource: transfer-schema
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Retrieve
Retrieve operation of resource: transfer-schema
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"schema-name": "string"
}
DEFAULT-COMMUNITY-MAPS - Update
Update operation of resource: default-community-maps
default-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Create
Create operation of resource: default-community-maps
default-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Delete
Delete operation of resource: default-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Retrieve
Retrieve operation of resource: default-community-maps
Successful operation
Internal Error
DEFAULT-COMMUNITY-MAP - Update
Update operation of resource: default-community-map
default-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Create
Create operation of resource: default-community-map
default-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Delete
Delete operation of resource: default-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Retrieve
Retrieve operation of resource: default-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
OVERLOAD-CONTROL - Update
Update operation of resource: overload-control
overload-controlbody object
Request Content-Types: application/json
Request Example
{
"drop-time": "integer",
"throttle-rate": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Create
Create operation of resource: overload-control
overload-controlbody object
Request Content-Types: application/json
Request Example
{
"drop-time": "integer",
"throttle-rate": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Delete
Delete operation of resource: overload-control
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Retrieve
Retrieve operation of resource: overload-control
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"drop-time": "integer",
"throttle-rate": "integer"
}
TIMEOUTS - Update
Update operation of resource: timeouts
timeoutsbody object
Request Content-Types: application/json
Request Example
{
"duplicates": "integer",
"threshold": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Create
Create operation of resource: timeouts
timeoutsbody object
Request Content-Types: application/json
Request Example
{
"duplicates": "integer",
"threshold": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Delete
Delete operation of resource: timeouts
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Retrieve
Retrieve operation of resource: timeouts
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"duplicates": "integer",
"threshold": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
USERS - Update
Update operation of resource: users
usersbody object
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Create
Create operation of resource: users
usersbody object
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Delete
Delete operation of resource: users
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Retrieve
Retrieve operation of resource: users
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
USER - Update
Update operation of resource: user
userbody object
ID of user-name
Request Content-Types: application/json
Request Example
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
USER - Create
Create operation of resource: user
userbody object
ID of user-name
Request Content-Types: application/json
Request Example
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
USER - Delete
Delete operation of resource: user
ID of user-name
Successful operation
Internal Error
Response Content-Types: application/json
USER - Retrieve
Retrieve operation of resource: user
ID of user-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string", {
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
]
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of name
Successful operation
Internal Error
TRAP-HOSTS - Update
Update operation of resource: trap-hosts
trap-hostsbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Create
Create operation of resource: trap-hosts
trap-hostsbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Delete
Delete operation of resource: trap-hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Retrieve
Retrieve operation of resource: trap-hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
TRAP-HOST - Update
Update operation of resource: trap-host
trap-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Create
Create operation of resource: trap-host
trap-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Delete
Delete operation of resource: trap-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Retrieve
Retrieve operation of resource: trap-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-HOST - Update
Update operation of resource: inform-host
inform-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Create
Create operation of resource: inform-host
inform-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Delete
Delete operation of resource: inform-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Retrieve
Retrieve operation of resource: inform-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
INFORM-USER-COMMUNITIES - Update
Update operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Create
Create operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Delete
Delete operation of resource: inform-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
INFORM-USER-COMMUNITY - Update
Update operation of resource: inform-user-community
inform-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Create
Create operation of resource: inform-user-community
inform-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Delete
Delete operation of resource: inform-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: inform-encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
INFORM-ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: inform-encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
DEFAULT-USER-COMMUNITIES - Update
Update operation of resource: default-user-communities
default-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Create
Create operation of resource: default-user-communities
default-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Delete
Delete operation of resource: default-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: default-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
DEFAULT-USER-COMMUNITY - Update
Update operation of resource: default-user-community
default-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Create
Create operation of resource: default-user-community
default-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Delete
Delete operation of resource: default-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Retrieve
Retrieve operation of resource: default-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
CONTEXTS - Update
Update operation of resource: contexts
contextsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Create
Create operation of resource: contexts
contextsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Delete
Delete operation of resource: contexts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Retrieve
Retrieve operation of resource: contexts
ID of name
Successful operation
Internal Error
CONTEXT - Update
Update operation of resource: context
contextbody object
ID of name
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Create
Create operation of resource: context
contextbody object
ID of name
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Delete
Delete operation of resource: context
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Retrieve
Retrieve operation of resource: context
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-name": "string"
}
CONTEXT-MAPPINGS - Update
Update operation of resource: context-mappings
context-mappingsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Create
Create operation of resource: context-mappings
context-mappingsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Delete
Delete operation of resource: context-mappings
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Retrieve
Retrieve operation of resource: context-mappings
ID of name
Successful operation
Internal Error
CONTEXT-MAPPING - Update
Update operation of resource: context-mapping
context-mappingbody object
ID of name
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Create
Create operation of resource: context-mapping
context-mappingbody object
ID of name
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Delete
Delete operation of resource: context-mapping
ID of name
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Retrieve
Retrieve operation of resource: context-mapping
ID of name
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
GROUPS - Update
Update operation of resource: groups
groupsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Create
Create operation of resource: groups
groupsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Delete
Delete operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Retrieve
Retrieve operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
GROUP - Update
Update operation of resource: group
groupbody object
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Create
Create operation of resource: group
groupbody object
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Delete
Delete operation of resource: group
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Retrieve
Retrieve operation of resource: group
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
TRAP-HOSTS - Update
Update operation of resource: trap-hosts
trap-hostsbody object
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Create
Create operation of resource: trap-hosts
trap-hostsbody object
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Delete
Delete operation of resource: trap-hosts
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Retrieve
Retrieve operation of resource: trap-hosts
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
TRAP-HOST - Update
Update operation of resource: trap-host
trap-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Create
Create operation of resource: trap-host
trap-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Delete
Delete operation of resource: trap-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Retrieve
Retrieve operation of resource: trap-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-HOST - Update
Update operation of resource: inform-host
inform-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Create
Create operation of resource: inform-host
inform-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Delete
Delete operation of resource: inform-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Retrieve
Retrieve operation of resource: inform-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
INFORM-USER-COMMUNITIES - Update
Update operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Create
Create operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Delete
Delete operation of resource: inform-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-user-communities
ID of ip-address
Successful operation
Internal Error
INFORM-USER-COMMUNITY - Update
Update operation of resource: inform-user-community
inform-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Create
Create operation of resource: inform-user-community
inform-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Delete
Delete operation of resource: inform-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: inform-encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
INFORM-ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: inform-encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
DEFAULT-USER-COMMUNITIES - Update
Update operation of resource: default-user-communities
default-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Create
Create operation of resource: default-user-communities
default-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Delete
Delete operation of resource: default-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: default-user-communities
ID of ip-address
Successful operation
Internal Error
DEFAULT-USER-COMMUNITY - Update
Update operation of resource: default-user-community
default-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Create
Create operation of resource: default-user-community
default-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Delete
Delete operation of resource: default-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Retrieve
Retrieve operation of resource: default-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
CONTEXTS - Update
Update operation of resource: contexts
contextsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Create
Create operation of resource: contexts
contextsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Delete
Delete operation of resource: contexts
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Retrieve
Retrieve operation of resource: contexts
Successful operation
Internal Error
CONTEXT - Update
Update operation of resource: context
contextbody object
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Create
Create operation of resource: context
contextbody object
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Delete
Delete operation of resource: context
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Retrieve
Retrieve operation of resource: context
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-name": "string"
}
CONTEXT-MAPPINGS - Update
Update operation of resource: context-mappings
context-mappingsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Create
Create operation of resource: context-mappings
context-mappingsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Delete
Delete operation of resource: context-mappings
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Retrieve
Retrieve operation of resource: context-mappings
Successful operation
Internal Error
CONTEXT-MAPPING - Update
Update operation of resource: context-mapping
context-mappingbody object
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Create
Create operation of resource: context-mapping
context-mappingbody object
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Delete
Delete operation of resource: context-mapping
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Retrieve
Retrieve operation of resource: context-mapping
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
MIB - Update
Update operation of resource: mib
mibbody object
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Create
Create operation of resource: mib
mibbody object
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Delete
Delete operation of resource: mib
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Retrieve
Retrieve operation of resource: mib
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
Schema Definitions
ACTION-TYPE:
Common node of timeout, verify-error, connection-loss, jitter-average-sd, jitter-average-ds, jitter-average, packet-loss-ds , packet-loss-sd, rtt
- action-type: object
-
Type of action to be taken on threshold violation(s)
-
- trigger: null
-
Generate trigger to active reaction triggered operation(s)
- logging: null
-
Generate a syslog alarm on threshold violation
Example
{
"action-type": {
"trigger": [ null ],
"logging": [ null ]
}
}
IPSLA-MPLSLM-REACT-CFG-CREATE:
Common node of mpls-lsp-ping, mpls-lsp-traceCommon node of timeout, verify-error, connection-loss, jitter-average, jitter-average-sd, jitter-average-ds, packet-loss-sd, packet-loss-ds, rttCommon node of timeout, connection-loss, lpd-tree-trace, lpd-group
- create: null
-
Create reaction condition for a particular MPLSLM
Example
{
"create": [ null ]
}
SCAN:
Common node of mpls-lsp-ping, mpls-lsp-trace
- scan: object
-
Scanning parameters configuration
-
- delete-factor: integer
-
Number of times for automatic deletion
range:"0..2147483647" default:"1" - interval: integer
-
Time interval for automatic discovery
units:"minute" default:"240"
Example
{
"scan": {
"delete-factor": "integer",
"interval": "integer"
}
}
TOS:
Common node of icmp-echo, icmp-path-echo, icmp-path-jitter, udp-echo, udp-jitter
- tos: integer
-
Type of service setting in probe packet
range:"0..255" default:"0"
Example
{
"tos": "integer"
}
IPSLA-OP-DEF-COMMON-CFG-TAG:
Common node of mpls-lsp-ping, mpls-lsp-traceCommon node of icmp-echo, icmp-path-echo, icmp-path-jitter, udp-echo, udp-jitter, mpls-lsp-ping, mpls-lsp-trace
- tag: string
-
Add a tag for this operation
Example
{
"tag": "string"
}
DSCP-BITS:
Common node of reply, reply
- dscp-bits: string
-
DSCP bits in the reply IP header
Example
{
"dscp-bits": "string"
}
DEST-PORT:
Common node of udp-echo, udp-jitter
- dest-port: string
-
Port number on target device
Example
{
"dest-port": "string"
}
TIMEOUT:
Common node of mpls-lsp-ping, mpls-lsp-trace
- timeout: integer
-
Probe/Control timeout in milliseconds
range:"1..600000" units:"millisecond" default:"5000"
Example
{
"timeout": "integer"
}
CONTROL-DISABLE:
Common node of udp-echo, udp-jitter
- control-disable: null
-
Disable control packets
Example
{
"control-disable": [ null ]
}
LSP-SELECTOR:
Common node of mpls-lsp-ping, mpls-lsp-trace
- lsp-selector: string
-
Attributes used for path selection during LSP load balancing
Example
{
"lsp-selector": "string"
}
FORCE-EXPLICIT-NULL:
Common node of mpls-lsp-ping, mpls-lsp-trace
- force-explicit-null: null
-
Forced option for the MPLS LSP operation
Example
{
"force-explicit-null ]: [ null ]
}
IPSLA-MPLSLM-DEF-CFG-LSP-SELECTOR:
Common node of mpls-lsp-ping, mpls-lsp-traceCommon node of mpls-lsp-ping, mpls-lsp-trace
- lsp-selector: string
-
Attributes used for path selection during LSP load balancing
Example
{
"lsp-selector": "string"
}
OUTPUT-INTERFACE:
Common node of mpls-lsp-ping, mpls-lsp-trace
- output-interface: string
-
Echo request output interface
Example
{
"output-interface": "string"
}
CREATE:
Common node of mpls-lsp-ping, mpls-lsp-trace
- create: null
-
Create MPLSLM instance with specified type
Example
{
"create": [ null ]
}
IPSLA-OP-DEF-MPLS-LSP-CFG-EXP-BITS:
Common node of mpls-lsp-ping, mpls-lsp-traceCommon node of mpls-lsp-ping, mpls-lsp-trace
- exp-bits: integer
-
EXP bits in MPLS LSP echo reply header
range:"0..7" default:"0"
Example
{
"exp-bits": "integer"
}
IPSLA-MPLSLM-DEF-CFG-VRF:
Common node of icmp-echo, icmp-path-echo, icmp-path-jitter, udp-echo, udp-jitterCommon node of mpls-lsp-ping, mpls-lsp-trace
- vrf: string
-
Specify a VRF instance to be monitored
Example
{
"vrf": "string"
}
THRESHOLD-TYPE:
Common node of timeout, connection-loss
- threshold-type: object
-
Type of thresholding to perform on the monitored element
-
- thresh-type: string immediate, consecutive
-
Type of thresholding to perform
- count1: integer
-
Probe count for consecutive
range:"1..16" - count2: integer
-
Y value, when threshold type is XofY
range:"1..16"
Example
{
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
IPSLA-MPLSLM-DEF-CFG-FORCE-EXPLICIT-NULL:
Common node of mpls-lsp-ping, mpls-lsp-traceCommon node of mpls-lsp-ping, mpls-lsp-trace
- force-explicit-null: null
-
Forced option for the MPLS LSP operation
Example
{
"force-explicit-null ]: [ null ]
}
TAG:
Common node of mpls-lsp-ping, mpls-lsp-trace
- tag: string
-
Add a tag for this MPLSLM instance
Example
{
"tag": "string"
}
VRF:
Common node of icmp-echo, icmp-path-echo, icmp-path-jitter, udp-echo, udp-jitter
- vrf: string
-
Configure IPSLA for a VPN Routing/Forwarding instance)
Example
{
"vrf": "string"
}
THRESHOLD-LIMITS:
Common node of jitter-average-sd, jitter-average-ds, jitter-average, packet-loss-ds , packet-loss-sd, rtt
- threshold-limits: object
-
Specify threshold limits for the monitored element
-
- upper-limit: integer
-
Threshold upper limit value
range:"1..4294967295" - lower-limit: integer
-
Threshold lower limit value
range:"1..4294967295"
Example
{
"threshold-limits": {
"upper-limit": "integer",
"lower-limit": "integer"
}
}
IPSLA-MPLSLM-REACT-CFG-ACTION-TYPE:
Common node of timeout, verify-error, connection-loss, jitter-average-sd, jitter-average-ds, jitter-average, packet-loss-ds , packet-loss-sd, rttCommon node of timeout, connection-loss, lpd-tree-trace, lpd-group
- action-type: object
-
Type of action to be taken on threshold violation(s)
-
- logging: null
-
Generate a syslog alarm on threshold violation
Example
{
"action-type": {
"logging": [ null ]
}
}
DEST-ADDRESS:
Common node of icmp-echo, icmp-path-echo, icmp-path-jitter, udp-echo, udp-jitter
- dest-address: string
-
Enter IPv4 address of the destination device
Example
{
"dest-address": "string"
}
IPSLA-MPLSLM-DEF-CFG-OUTPUT-NEXTHOP:
Common node of mpls-lsp-ping, mpls-lsp-traceCommon node of mpls-lsp-ping, mpls-lsp-trace
- output-nexthop: string
-
Echo request output nexthop
Example
{
"output-nexthop": "string"
}
ACCESSLIST:
Common node of mpls-lsp-ping, mpls-lsp-trace
- accesslist: string
-
Apply access list to filter PE addresses
Example
{
"accesslist": "string"
}
ENHANCED-STATS-TABLE:
Common node of icmp-echo, udp-echo, udp-jitter, mpls-lsp-ping
- enhanced-stats: object
-
Table of statistics collection intervals
-
- enhanced-stat: object[]
-
Statistics for a specified time interval
-
object - buckets: integer
-
Buckets of enhanced statistics kept
range:"1..60" default:"15" - interval: integer
-
Interval in seconds
units:"minute" default:"240"
Example
{
"enhanced-stats": {
"enhanced-stat": [
{
"buckets": "integer",
"interval": "integer"
}
]
}
}
IPSLA-OP-DEF-COMMON-CFG-TIMEOUT:
Common node of mpls-lsp-ping, mpls-lsp-traceCommon node of icmp-echo, icmp-path-echo, icmp-path-jitter, udp-echo, udp-jitter, mpls-lsp-ping, mpls-lsp-trace
- timeout: integer
-
Probe/Control timeout in milliseconds
range:"1..600000" units:"millisecond" default:"5000"
Example
{
"timeout": "integer"
}
REPLY:
Common node of mpls-lsp-ping, mpls-lsp-trace
- reply: object
-
Echo reply options for the MPLS LSP operation
-
- mode: string ipv4-udp-router-alert
-
Enables use of router alert in echo reply packets
- dscp-bits: string
-
DSCP bits in the reply IP header
Example
{
"reply": {
"mode": "string",
"dscp-bits": "string"
}
}
SOURCE-PORT:
Common node of udp-echo, udp-jitter
- source-port: string
-
Port number on source device
Example
{
"source-port": "string"
}
IPSLA-OP-REACT-CFG-THRESHOLD-TYPE:
Common node of timeout, connection-lossCommon node of timeout, verify-error, connection-loss, jitter-average-sd, jitter-average-ds, jitter-average, packet-loss-ds, packet-loss-sd, rtt
- threshold-type: object
-
Type of thresholding to perform on the monitored element
-
- thresh-type: string immediate, consecutive, xof-y, average
-
Type of thresholding to perform
- count1: integer
-
Probe count for avarage, consecutive case or X value for XofY case
range:"1..16" - count2: integer
-
Y value, when threshold type is XofY
range:"1..16"
Example
{
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
LSR-PATH:
Common node of icmp-path-echo, icmp-path-jitter
- lsr-path: object
-
Loose source routing path (up to 8 intermediate nodes)
-
- node8: string
-
IPv4 address of the intermediate node
- node1: string
-
IPv4 address of the intermediate node
- node3: string
-
IPv4 address of the intermediate node
- node2: string
-
IPv4 address of the intermediate node
- node5: string
-
IPv4 address of the intermediate node
- node4: string
-
IPv4 address of the intermediate node
- node7: string
-
IPv4 address of the intermediate node
- node6: string
-
IPv4 address of the intermediate node
Example
{
"lsr-path": {
"node8": "string",
"node1": "string",
"node3": "string",
"node2": "string",
"node5": "string",
"node4": "string",
"node7": "string",
"node6": "string"
}
}
HISTORY:
Common node of icmp-echo, udp-echo, mpls-lsp-ping , mpls-lsp-trace
- history: object
-
Configure the history parameters for this operation
-
- buckets: integer
-
Specify number of history buckets
range:"1..60" default:"15" - lives: integer
-
Specify number of lives to be kept
range:"0..2" default:"0" - history-filter: string failed, all
-
Choose type of data to be stored in history buffer
Example
{
"history": {
"buckets": "integer",
"lives": "integer",
"history-filter": "string"
}
}
EXP-BITS:
Common node of mpls-lsp-ping, mpls-lsp-trace
- exp-bits: integer
-
EXP bits in MPLS LSP echo request header
range:"0..7" default:"0"
Example
{
"exp-bits": "integer"
}
STATISTICS:
Common node of icmp-echo, udp-echo, udp-jitter, mpls-lsp-ping, mpls-lsp-trace
- statistics: object
-
Statistics collection aggregated over an hour
-
- hours: integer
-
Number of hours for which hourly statistics are kept
range:"0..25" units:"hour" default:"2" - dist-count: integer
-
Count of distribution intervals maintained
range:"1..20" default:"1" - dist-interval: integer
-
Specify distribution interval in milliseconds
range:"1..100" units:"millisecond" default:"20"
Example
{
"statistics": {
"hours": "integer",
"dist-count": "integer",
"dist-interval": "integer"
}
}
IPSLA-OP-REACT-CFG-CREATE:
Common node of mpls-lsp-ping, mpls-lsp-traceCommon node of timeout, verify-error, connection-loss, jitter-average, jitter-average-sd, jitter-average-ds, packet-loss-sd, packet-loss-ds, rtt
- create: null
-
Create reaction condition for a particular operation
Example
{
"create": [ null ]
}
SOURCE-ADDRESS:
Common node of icmp-echo, icmp-path-echo, icmp-path-jitter, udp-echo, udp-jitter, mpls-lsp-ping, mpls-lsp-trace
- source-address: string
-
Enter IPv4 address of the source device
Example
{
"source-address": "string"
}
IPSLA-MPLSLM-DEF-CFG-STATISTICS:
Common node of icmp-echo, udp-echo, udp-jitter, mpls-lsp-ping, mpls-lsp-traceCommon node of mpls-lsp-ping, mpls-lsp-trace
- statistics: object
-
Statistics collection aggregated over an hour
-
- hours: integer
-
Number of hours for which hourly statistics are kept
range:"0..25" units:"hour" default:"2"
Example
{
"statistics": {
"hours": "integer"
}
}
OUTPUT-NEXTHOP:
Common node of mpls-lsp-ping, mpls-lsp-trace
- output-nexthop: string
-
Echo request output nexthop
Example
{
"output-nexthop": "string"
}
FREQUENCY:
Common node of icmp-echo, icmp-path-echo, icmp-path-jitter, udp-echo, udp-jitter, mpls-lsp-ping, mpls-lsp-trace
- frequency: integer
-
Probe interval in seconds
range:"1..604800" units:"second" default:"60"
Example
{
"frequency": "integer"
}
IPSLA-OP-DEF-MPLS-LSP-CFG-OUTPUT-INTERFACE:
Common node of mpls-lsp-ping, mpls-lsp-traceCommon node of mpls-lsp-ping, mpls-lsp-trace
- output-interface: string
-
Echo request output interface
Example
{
"output-interface": "string"
}
VERIFY-DATA:
Common node of udp-echo, udp-jitter
- verify-data: null
-
Check each IPSLA response for corruption
Example
{
"verify-data": [ null ]
}
ipsla_schema:
IPSLA configuration
- responder: object
-
Responder configuration
-
- twamp: object
-
Responder TWAMP configuration
-
- timeout: integer
-
Configure responder timeout value in seconds
range:"1..600000" units:"millisecond" default:"5000"
- type: object
-
Configure IPSLA Responder port type
-
- udp: object
-
Configure IPSLA Responder UDP address and port
-
- addresses: object
-
Configure IP address
-
- address: object[]
-
Configure IP address for the permanent port
-
object - local-address: string
-
IP address of the Responder
- ports: object
-
Configure port
-
- port: object[]
-
Configure port number for the permanent port
-
object - port: string
-
Port number to be enabled
- mpls-lsp-monitor: object
-
MPLS LSP Monitor(MPLSLM) configuration
-
- reactions: object
-
MPLSLM Reaction configuration
-
- reaction: object[]
-
Reaction configuration for an MPLSLM instance
-
object - condition: object
-
Reaction condition specification
-
- lpd-tree-trace: IPSLA-MPLSLM-REACT-CFG-CREATE
-
React on LPD Tree Trace violation for a monitored MPLSLM
- lpd-group: IPSLA-MPLSLM-REACT-CFG-CREATE
-
React on LPD Group violation for a monitored MPLSLM
- timeout: IPSLA-MPLSLM-REACT-CFG-CREATE
-
React on probe timeout
- connection-loss: IPSLA-MPLSLM-REACT-CFG-CREATE
-
React on connection loss for a monitored MPLSLM
- monitor-id: integer
-
Monitor identifier
range:"1..2048"
- definitions: object
-
MPLS LSP Monitor definition table
-
- definition: object[]
-
MPLS LSP Monitor definition
-
object - operation-type: object
-
Operation type specification
-
- mpls-lsp-trace:
-
Perform MPLS LSP Trace operation
- mpls-lsp-ping:
-
Perform MPLS LSP Ping operation
- monitor-id: integer
-
Monitor identifier
range:"1..2048"
- schedules: object
-
MPLSLM schedule configuration
-
- schedule: object[]
-
Schedule an MPLSLM instance
-
object - frequency: integer
-
Group schedule frequency of the probing
range:"1..604800" units:"second" default:"60" - start-time: object
-
Start time of MPLSLM instance
-
- hour: integer
-
Hour value(hh) in hh:mm:ss specification
range:"0..23" - month: string january, february, march, april, may, june, july, august, september, october, november, december
-
Month of the year (optional. Default current month)
- second: integer
-
Second value(ss) in hh:mm:ss specification
range:"0..59" - schedule-type: string pending, now, after, at
-
Type of schedule
- year: integer
-
Year (optional. Default current year)
range:"1993..2035" - day: integer
-
Day of the month(optional. Default today)
range:"1..31" - minute: integer
-
Minute value(mm) in hh:mm:ss specification
range:"0..59"
- period: integer
-
Group schedule period range
range:"1..604800" units:"second" - monitor-id: integer
-
Monitor indentifier
range:"1..2048"
- common: object
-
IPSLA application common configuration
-
- low-memory: integer
-
Configure low memory water mark (default 20M)
range:"0..4294967295" default:20M)" - authentication: object
-
Authenticaion configuration
-
- key-chain: string
-
Use MD5 authentication for IPSLA control message
- hardware-timestamp: object
-
Hardware Timestamp configuration
-
- disable: null
-
states true if hw-timestamp is disabled
- server-twamp: object
-
IPPM Server configuration
-
- inactivity-timer: integer
-
Configure ippmserver inactivity timer value in seconds
range:"1..6000" units:"second" default:"900" - port: string
-
Configure port number for ippmserver listening port
- operation: object
-
IPSLA Operation configuration
-
- reaction-triggers: object
-
Reaction trigger configuration
-
- reaction-trigger: object[]
-
Reaction trigger for an operation
-
object - triggered-op-id: integer
-
Operation number of the operation to be triggered
range:"1..2048" - operation-id: integer
-
Operation number of the operation generating a trigger
range:"1..2048"
- reactions: object
-
Reaction configuration
-
- reaction: object[]
-
Reaction configuration for an operation
-
object - condition: object
-
Reaction condition specification
-
- timeout: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on probe timeout
- jitter-average-ds: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on destination to source jitter threshold violation
- rtt: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on round trip time threshold violation
- packet-loss-ds: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on source to destination packet loss threshold violation
- jitter-average-sd: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on average source to destination jitter threshold violation
- packet-loss-sd: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on destination to source packet loss threshold violation
- jitter-average: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on average round trip jitter threshold violation
- verify-error: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on error verfication violation
- connection-loss: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on connection loss for a monitored operation
- operation-id: integer
-
Operation number
range:"1..2048"
- definitions: object
-
Operation definition table
-
- definition: object[]
-
Operation definition
-
object - operation-type: object
-
Operation type specification
-
- udp-echo:
-
UDPEcho Operation type
- icmp-path-jitter:
-
ICMPPathJitter Operation type
- udp-jitter:
-
UDPJitter Operation type
- icmp-echo:
-
ICMPEcho Operation type
- mpls-lsp-trace:
-
MPLS LSP Trace Operation type
- icmp-path-echo:
-
ICMPPathEcho Operation type
- mpls-lsp-ping:
-
MPLS LSP Ping Operation type
- operation-id: integer
-
Operation number
range:"1..2048"
- schedules: object
-
Schedule an operation
-
- schedule: object[]
-
Operation schedule configuration
-
object - ageout: integer
-
How long to keep this entry after it becomes inactive
range:"0..2073600" units:"second" - life: string
-
Length of the time to execute (default 3600 seconds)
- recurring: null
-
probe to be scheduled automatically every day
- start-time: object
-
Start time of the operation
-
- hour: integer
-
Hour value(hh) in hh:mm:ss specification
range:"0..23" - month: string january, february, march, april, may, june, july, august, september, october, november, december
-
Month of the year (optional. Default current month)
- second: integer
-
Second value(ss) in hh:mm:ss specification
range:"0..59" - schedule-type: string pending, now, after, at
-
Type of schedule
- year: integer
-
Year(optional. Default current year)
range:"1993..2035" - day: integer
-
Day of the month(optional. Default today)
range:"1..31" - minute: integer
-
Minute value(mm) in hh:mm:ss specification
range:"0..59"
- operation-id: integer
-
Operation number
range:"1..2048"
- mpls-discovery: object
-
Provider Edge(PE) discovery configuration
-
- vpn: object
-
Layer 3 VPN PE discovery configuration
-
- interval: integer
-
Specify a discovery refresh interval
units:"minute" default:"240"
Example
{
"responder": {
"twamp": {
"timeout": "integer"
},
"type": {
"udp": {
"addresses": {
"address": [
{
"local-address": "string",
"ports": {
"port": [
{
"port": "string"
}
]
}
}
]
}
}
}
},
"mpls-lsp-monitor": {
"reactions": {
"reaction": [
{
"condition": {
"lpd-tree-trace": {
"create": [ null ]
},
"lpd-group": {
"create": [ null ]
},
"timeout": {
"create": [ null ]
},
"connection-loss": {
"create": [ null ]
}
},
"monitor-id": "integer"
}
]
},
"definitions": {
"definition": [
{
"operation-type": {
"mpls-lsp-trace": {
"ttl": "integer",
"vrf": "string"
},
"mpls-lsp-ping": {
"data-size": {
"request": "integer"
},
"path-discover": {
"path": {
"secondary-frequency": {
"frequency": "integer",
"type": "string"
},
"retry": "integer"
},
"create": [ null ],
"session": {
"limit": "integer",
"timeout": "integer"
},
"scan-period": "integer",
"echo": {
"maximum-lsp-selector": "string",
"multipath": {
"bitmap-size": "integer"
},
"retry": "integer",
"timeout": "integer",
"interval": "integer"
}
},
"ttl": "integer",
"vrf": "string"
}
},
"monitor-id": "integer"
}
]
},
"schedules": {
"schedule": [
{
"frequency": "integer",
"start-time": {
"hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"period": "integer",
"monitor-id": "integer"
}
]
}
},
"common": {
"low-memory": "integer",
"authentication": {
"key-chain": "string"
},
"hardware-timestamp": {
"disable": [ null ]
}
},
"server-twamp": {
"inactivity-timer": "integer",
"port": "string"
},
"operation": {
"reaction-triggers": {
"reaction-trigger": [
{
"triggered-op-id": "integer",
"operation-id": "integer"
}
]
},
"reactions": {
"reaction": [ null ]
}
}
}
common_schema:
IPSLA application common configuration
- low-memory: integer
-
Configure low memory water mark (default 20M)
range:"0..4294967295" default:20M)" - authentication: object
-
Authenticaion configuration
-
- key-chain: string
-
Use MD5 authentication for IPSLA control message
- hardware-timestamp: object
-
Hardware Timestamp configuration
-
- disable: null
-
states true if hw-timestamp is disabled
Example
{
"low-memory": "integer",
"authentication": {
"key-chain": "string"
},
"hardware-timestamp": {
"disable": [ null ]
}
}
hardware-timestamp_schema:
Hardware Timestamp configuration
- disable: null
-
states true if hw-timestamp is disabled
Example
{
"disable": [ null ]
}
authentication_schema:
Authenticaion configuration
- key-chain: string
-
Use MD5 authentication for IPSLA control message
Example
{
"key-chain": "string"
}
mpls-lsp-monitor_schema:
MPLS LSP Monitor(MPLSLM) configuration
- reactions: object
-
MPLSLM Reaction configuration
-
- reaction: object[]
-
Reaction configuration for an MPLSLM instance
-
object - condition: object
-
Reaction condition specification
-
- lpd-tree-trace: IPSLA-MPLSLM-REACT-CFG-CREATE
-
React on LPD Tree Trace violation for a monitored MPLSLM
- lpd-group: IPSLA-MPLSLM-REACT-CFG-CREATE
-
React on LPD Group violation for a monitored MPLSLM
- timeout: IPSLA-MPLSLM-REACT-CFG-CREATE
-
React on probe timeout
- connection-loss: IPSLA-MPLSLM-REACT-CFG-CREATE
-
React on connection loss for a monitored MPLSLM
- monitor-id: integer
-
Monitor identifier
range:"1..2048"
- definitions: object
-
MPLS LSP Monitor definition table
-
- definition: object[]
-
MPLS LSP Monitor definition
-
object - operation-type: object
-
Operation type specification
-
- mpls-lsp-trace:
-
Perform MPLS LSP Trace operation
- mpls-lsp-ping:
-
Perform MPLS LSP Ping operation
- monitor-id: integer
-
Monitor identifier
range:"1..2048"
- schedules: object
-
MPLSLM schedule configuration
-
- schedule: object[]
-
Schedule an MPLSLM instance
-
object - frequency: integer
-
Group schedule frequency of the probing
range:"1..604800" units:"second" default:"60" - start-time: object
-
Start time of MPLSLM instance
-
- hour: integer
-
Hour value(hh) in hh:mm:ss specification
range:"0..23" - month: string january, february, march, april, may, june, july, august, september, october, november, december
-
Month of the year (optional. Default current month)
- second: integer
-
Second value(ss) in hh:mm:ss specification
range:"0..59" - schedule-type: string pending, now, after, at
-
Type of schedule
- year: integer
-
Year (optional. Default current year)
range:"1993..2035" - day: integer
-
Day of the month(optional. Default today)
range:"1..31" - minute: integer
-
Minute value(mm) in hh:mm:ss specification
range:"0..59"
- period: integer
-
Group schedule period range
range:"1..604800" units:"second" - monitor-id: integer
-
Monitor indentifier
range:"1..2048"
Example
{
"reactions": {
"reaction": [
{
"condition": {
"lpd-tree-trace": {
"create": [ null ]
},
"lpd-group": {
"create": [ null ]
},
"timeout": {
"create": [ null ]
},
"connection-loss": {
"create": [ null ]
}
},
"monitor-id": "integer"
}
]
},
"definitions": {
"definition": [
{
"operation-type": {
"mpls-lsp-trace": {
"ttl": "integer",
"vrf": "string"
},
"mpls-lsp-ping": {
"data-size": {
"request": "integer"
},
"path-discover": {
"path": {
"secondary-frequency": {
"frequency": "integer",
"type": "string"
},
"retry": "integer"
},
"create": [ null ],
"session": {
"limit": "integer",
"timeout": "integer"
},
"scan-period": "integer",
"echo": {
"maximum-lsp-selector": "string",
"multipath": {
"bitmap-size": "integer"
},
"retry": "integer",
"timeout": "integer",
"interval": "integer"
}
},
"ttl": "integer",
"vrf": "string"
}
},
"monitor-id": "integer"
}
]
},
"schedules": {
"schedule": [
{
"frequency": "integer",
"start-time": {
"hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"period": "integer",
"monitor-id": "integer"
}
]
}
}
reactions_schema:
Reaction configuration
- reaction: object[]
-
Reaction configuration for an operation
-
object - condition: object
-
Reaction condition specification
-
- timeout: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on probe timeout
- jitter-average-ds: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on destination to source jitter threshold violation
- rtt: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on round trip time threshold violation
- packet-loss-ds: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on source to destination packet loss threshold violation
- jitter-average-sd: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on average source to destination jitter threshold violation
- packet-loss-sd: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on destination to source packet loss threshold violation
- jitter-average: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on average round trip jitter threshold violation
- verify-error: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on error verfication violation
- connection-loss: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on connection loss for a monitored operation
- operation-id: integer
-
Operation number
range:"1..2048"
Example
{
"reaction": [
{
"condition": {
"timeout": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average-ds": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"rtt": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"packet-loss-ds": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average-sd": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"packet-loss-sd": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"verify-error": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"connection-loss": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
]
}
reaction_schema:
- condition: object
-
Reaction condition specification
-
- timeout: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on probe timeout
- jitter-average-ds: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on destination to source jitter threshold violation
- rtt: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on round trip time threshold violation
- packet-loss-ds: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on source to destination packet loss threshold violation
- jitter-average-sd: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on average source to destination jitter threshold violation
- packet-loss-sd: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on destination to source packet loss threshold violation
- jitter-average: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on average round trip jitter threshold violation
- verify-error: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on error verfication violation
- connection-loss: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on connection loss for a monitored operation
- operation-id: integer
-
Operation number
range:"1..2048"
Example
{
"condition": {
"timeout": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average-ds": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"rtt": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"packet-loss-ds": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average-sd": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"packet-loss-sd": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"verify-error": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"connection-loss": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
condition_schema:
Reaction condition specification
- timeout: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on probe timeout
- jitter-average-ds: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on destination to source jitter threshold violation
- rtt: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on round trip time threshold violation
- packet-loss-ds: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on source to destination packet loss threshold violation
- jitter-average-sd: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on average source to destination jitter threshold violation
- packet-loss-sd: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on destination to source packet loss threshold violation
- jitter-average: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on average round trip jitter threshold violation
- verify-error: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on error verfication violation
- connection-loss: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on connection loss for a monitored operation
Example
{
"timeout": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average-ds": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"rtt": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"packet-loss-ds": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average-sd": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"packet-loss-sd": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"verify-error": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"connection-loss": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
}
action-type_schema:
Type of action to be taken on threshold violation(s)
- trigger: null
-
Generate trigger to active reaction triggered operation(s)
- logging: null
-
Generate a syslog alarm on threshold violation
Example
{
"trigger": [ null ],
"logging": [ null ]
}
threshold-type_schema:
Type of thresholding to perform on the monitored element
- thresh-type: string immediate, consecutive, xof-y, average
-
Type of thresholding to perform
- count1: integer
-
Probe count for avarage, consecutive case or X value for XofY case
range:"1..16" - count2: integer
-
Y value, when threshold type is XofY
range:"1..16"
Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
schedules_schema:
Schedule an operation
- schedule: object[]
-
Operation schedule configuration
-
object - ageout: integer
-
How long to keep this entry after it becomes inactive
range:"0..2073600" units:"second" - life: string
-
Length of the time to execute (default 3600 seconds)
- recurring: null
-
probe to be scheduled automatically every day
- start-time: object
-
Start time of the operation
-
- hour: integer
-
Hour value(hh) in hh:mm:ss specification
range:"0..23" - month: string january, february, march, april, may, june, july, august, september, october, november, december
-
Month of the year (optional. Default current month)
- second: integer
-
Second value(ss) in hh:mm:ss specification
range:"0..59" - schedule-type: string pending, now, after, at
-
Type of schedule
- year: integer
-
Year(optional. Default current year)
range:"1993..2035" - day: integer
-
Day of the month(optional. Default today)
range:"1..31" - minute: integer
-
Minute value(mm) in hh:mm:ss specification
range:"0..59"
- operation-id: integer
-
Operation number
range:"1..2048"
Example
{
"schedule": [
{
"ageout": "integer",
"life": "string",
"recurring": [ null ],
"start-time": {
"hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"operation-id": "integer"
}
]
}
schedule_schema:
- ageout: integer
-
How long to keep this entry after it becomes inactive
range:"0..2073600" units:"second" - life: string
-
Length of the time to execute (default 3600 seconds)
- recurring: null
-
probe to be scheduled automatically every day
- start-time: object
-
Start time of the operation
-
- hour: integer
-
Hour value(hh) in hh:mm:ss specification
range:"0..23" - month: string january, february, march, april, may, june, july, august, september, october, november, december
-
Month of the year (optional. Default current month)
- second: integer
-
Second value(ss) in hh:mm:ss specification
range:"0..59" - schedule-type: string pending, now, after, at
-
Type of schedule
- year: integer
-
Year(optional. Default current year)
range:"1993..2035" - day: integer
-
Day of the month(optional. Default today)
range:"1..31" - minute: integer
-
Minute value(mm) in hh:mm:ss specification
range:"0..59"
- operation-id: integer
-
Operation number
range:"1..2048"
Example
{
"ageout": "integer",
"life": "string",
"recurring": [ null ],
"start-time": {
"hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"operation-id": "integer"
}
start-time_schema:
Start time of the operation
- hour: integer
-
Hour value(hh) in hh:mm:ss specification
range:"0..23" - month: string january, february, march, april, may, june, july, august, september, october, november, december
-
Month of the year (optional. Default current month)
- second: integer
-
Second value(ss) in hh:mm:ss specification
range:"0..59" - schedule-type: string pending, now, after, at
-
Type of schedule
- year: integer
-
Year(optional. Default current year)
range:"1993..2035" - day: integer
-
Day of the month(optional. Default today)
range:"1..31" - minute: integer
-
Minute value(mm) in hh:mm:ss specification
range:"0..59"
Example
{
"hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
}
definitions_schema:
Operation definition table
- definition: object[]
-
Operation definition
-
object - operation-type: object
-
Operation type specification
-
- udp-echo:
-
UDPEcho Operation type
- icmp-path-jitter:
-
ICMPPathJitter Operation type
- udp-jitter:
-
UDPJitter Operation type
- icmp-echo:
-
ICMPEcho Operation type
- mpls-lsp-trace:
-
MPLS LSP Trace Operation type
- icmp-path-echo:
-
ICMPPathEcho Operation type
- mpls-lsp-ping:
-
MPLS LSP Ping Operation type
- operation-id: integer
-
Operation number
range:"1..2048"
Example
{
"definition": [
{
"operation-type": {
"udp-echo": {
"data-size": {
"request": "integer"
},
"tag": "string"
},
"icmp-path-jitter": {
"data-size": {
"request": "integer"
},
"packet": {
"count": "integer",
"interval": "integer"
},
"tag": "string"
},
"udp-jitter": {
"data-size": {
"request": "integer"
},
"packet": {
"count": "integer",
"interval": "integer"
},
"tag": "string"
},
"icmp-echo": {
"data-size": {
"request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
},
"mpls-lsp-trace": {
"reply": {
"mode": "string",
"dscp-bits": "string"
},
"target": {
"ipv4": {
"fec-address": {
"mask": "string",
"address": "string"
}
},
"traffic-engineering": {
"tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
},
"icmp-path-echo": {
"statistics": {
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
},
"data-size": {
"request": "integer"
},
"history": {
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
},
"mpls-lsp-ping": {
"reply": {
"mode": "string",
"dscp-bits": "string"
},
"data-size": {
"request": "integer"
},
"target": {
"pseudowire": {
"target-address": {
"vc-id": "integer",
"address": "string"
}
},
"ipv4": {
"fec-address": {
"mask": "string",
"address": "string"
}
},
"traffic-engineering": {}
},
"tag": "string"
}
}
}
]
}
definition_schema:
- operation-type: object
-
Operation type specification
-
- udp-echo:
-
UDPEcho Operation type
- icmp-path-jitter:
-
ICMPPathJitter Operation type
- udp-jitter:
-
UDPJitter Operation type
- icmp-echo:
-
ICMPEcho Operation type
- mpls-lsp-trace:
-
MPLS LSP Trace Operation type
- icmp-path-echo:
-
ICMPPathEcho Operation type
- mpls-lsp-ping:
-
MPLS LSP Ping Operation type
- operation-id: integer
-
Operation number
range:"1..2048"
Example
{
"operation-type": {
"udp-echo": {
"data-size": {
"request": "integer"
},
"tag": "string"
},
"icmp-path-jitter": {
"data-size": {
"request": "integer"
},
"packet": {
"count": "integer",
"interval": "integer"
},
"tag": "string"
},
"udp-jitter": {
"data-size": {
"request": "integer"
},
"packet": {
"count": "integer",
"interval": "integer"
},
"tag": "string"
},
"icmp-echo": {
"data-size": {
"request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
},
"mpls-lsp-trace": {
"reply": {
"mode": "string",
"dscp-bits": "string"
},
"target": {
"ipv4": {
"fec-address": {
"mask": "string",
"address": "string"
}
},
"traffic-engineering": {
"tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
},
"icmp-path-echo": {
"statistics": {
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
},
"data-size": {
"request": "integer"
},
"history": {
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
},
"mpls-lsp-ping": {
"reply": {
"mode": "string",
"dscp-bits": "string"
},
"data-size": {
"request": "integer"
},
"target": {
"pseudowire": {
"target-address": {
"vc-id": "integer",
"address": "string"
}
},
"ipv4": {
"fec-address": {
"mask": "string",
"address": "string"
}
},
"traffic-engineering": {
"tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
}
}
operation-type_schema:
Operation type specification
- udp-echo:
-
UDPEcho Operation type
- icmp-path-jitter:
-
ICMPPathJitter Operation type
- udp-jitter:
-
UDPJitter Operation type
- icmp-echo:
-
ICMPEcho Operation type
- mpls-lsp-trace:
-
MPLS LSP Trace Operation type
- icmp-path-echo:
-
ICMPPathEcho Operation type
- mpls-lsp-ping:
-
MPLS LSP Ping Operation type
Example
{
"udp-echo": {
"data-size": {
"request": "integer"
},
"tag": "string"
},
"icmp-path-jitter": {
"data-size": {
"request": "integer"
},
"packet": {
"count": "integer",
"interval": "integer"
},
"tag": "string"
},
"udp-jitter": {
"data-size": {
"request": "integer"
},
"packet": {
"count": "integer",
"interval": "integer"
},
"tag": "string"
},
"icmp-echo": {
"data-size": {
"request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
},
"mpls-lsp-trace": {
"reply": {
"mode": "string",
"dscp-bits": "string"
},
"target": {
"ipv4": {
"fec-address": {
"mask": "string",
"address": "string"
}
},
"traffic-engineering": {
"tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
},
"icmp-path-echo": {
"statistics": {
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
},
"data-size": {
"request": "integer"
},
"history": {
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
},
"mpls-lsp-ping": {
"reply": {
"mode": "string",
"dscp-bits": "string"
},
"data-size": {
"request": "integer"
},
"target": {
"pseudowire": {
"target-address": {
"vc-id": "integer",
"address": "string"
}
},
"ipv4": {
"fec-address": {
"mask": "string",
"address": "string"
}
},
"traffic-engineering": {
"tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
}
mpls-lsp-trace_schema:
MPLS LSP Trace Operation type
- reply:
-
Echo reply options for the MPLS LSP operation
- target: object
-
Target for the MPLS LSP operation
-
- ipv4: object
-
Target specified as an IPv4 address
-
- fec-address: object
-
Target FEC address with mask
-
- mask: string
-
IP netmask for target
- address: string
-
IP address for target
- traffic-engineering: object
-
Traffic engineering target
-
- tunnel: integer
-
Tunnel interface number
range:"0..65535"
- ttl: integer
-
Time to live value
range:"1..255" default:"30"
Example
{
"reply": {
"mode": "string",
"dscp-bits": "string"
},
"target": {
"ipv4": {
"fec-address": {
"mask": "string",
"address": "string"
}
},
"traffic-engineering": {
"tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
reply_schema:
Echo reply options for the MPLS LSP operation
- mode: string ipv4-udp-router-alert
-
Enables use of router alert in echo reply packets
Example
{
"mode": "string",
"dscp-bits": "string"
}
statistics_schema:
Statistics collection aggregated over an hour
- dist-count: integer
-
Count of distribution intervals maintained
range:"1..20" default:"1" - paths: integer
-
Maximum number of paths for which statistics are kept
range:"1..128" default:"5" - hops: integer
-
Maximum hops per path for which statistics are kept
range:"1..30" default:"16" - hours: integer
-
Number of hours for which hourly statistics are kept
range:"0..25" units:"hour" default:"2" - dist-interval: integer
-
Specify distribution interval in milliseconds
range:"1..100" units:"millisecond" default:"20"
Example
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
scan_schema:
Scanning parameters configuration
- delete-factor: integer
-
Number of times for automatic deletion
range:"0..2147483647" default:"1" - interval: integer
-
Time interval for automatic discovery
units:"minute" default:"240"
Example
{
"delete-factor": "integer",
"interval": "integer"
}
mpls-lsp-ping_schema:
MPLS LSP Ping Operation type
- reply:
-
Echo reply options for the MPLS LSP operation
- data-size: object
-
Protocol data size in payload of probe packets
-
- request: integer
-
Payload size in request probe packet
range:"0..16384" units:"byte" default:"100"
- target: object
-
Target for the MPLS LSP operation
-
- pseudowire: object
-
Pseudowire target
-
- target-address: object
-
Target address
-
- vc-id: integer
-
Virtual circuit ID
range:"1..4294967295" - address: string
-
Target address
- ipv4: object
-
Target specified as an IPv4 address
-
- fec-address: object
-
Target FEC address with mask
-
- mask: string
-
IP netmask for target
- address: string
-
IP address for target
- traffic-engineering: object
-
Traffic engineering target
-
- tunnel: integer
-
Tunnel interface number
range:"0..65535"
- ttl: integer
-
Time to live value
range:"1..255" default:"30"
Example
{
"reply": {
"mode": "string",
"dscp-bits": "string"
},
"data-size": {
"request": "integer"
},
"target": {
"pseudowire": {
"target-address": {
"vc-id": "integer",
"address": "string"
}
},
"ipv4": {
"fec-address": {
"mask": "string",
"address": "string"
}
},
"traffic-engineering": {
"tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
data-size_schema:
Protocol data size in payload of probe packets
- request: integer
-
Payload size in request probe packet
range:"0..16384" units:"byte" default:"100"
Example
{
"request": "integer"
}
path-discover_schema:
Path discover configuration
- path: object
-
Path parameters configuration
-
- secondary-frequency: object
-
Frequency to be used if path failure condition is detected
-
- frequency: integer
-
Frequency value in seconds
range:"1..604800" units:"second" default:"60" - type: string connection-loss, timeout, both
-
Condition type of path failure
- retry: integer
-
Number of attempts before declaring the path as down
range:"0..100" default:"1"
- create: null
-
Create LPD instance
- session: object
-
Session parameters configuration
-
- limit: integer
-
Number of concurrent active path discovery requests at one time
range:"1..15" default:"1" - timeout: integer
-
Timeout value for path discovery request
range:"1..600000" units:"millisecond" default:"5000"
- scan-period: integer
-
Time period for finishing path discovery
range:"0..7200" units:"minute" default:"0" - echo: object
-
Echo parameters configuration
-
- maximum-lsp-selector: string
-
Maximum IPv4 address used as destination in echo request
- multipath: object
-
Downstream map multipath settings
-
- bitmap-size: integer
-
Multipath bit size
range:"1..256" default:"32"
- retry: integer
-
Number of timeout retry attempts during path discovery
range:"0..100" default:"1" - timeout: integer
-
Timeout value for echo requests during path discovery
range:"1..600000" units:"millisecond" default:"5000" - interval: integer
-
Send interval between echo requests during path discovery
units:"minute" default:"240"
Example
{
"path": {
"secondary-frequency": {
"frequency": "integer",
"type": "string"
},
"retry": "integer"
},
"create": [ null ],
"session": {
"limit": "integer",
"timeout": "integer"
},
"scan-period": "integer",
"echo": {
"maximum-lsp-selector": "string",
"multipath": {
"bitmap-size": "integer"
},
"retry": "integer",
"timeout": "integer",
"interval": "integer"
}
}
session_schema:
Session parameters configuration
- limit: integer
-
Number of concurrent active path discovery requests at one time
range:"1..15" default:"1" - timeout: integer
-
Timeout value for path discovery request
range:"1..600000" units:"millisecond" default:"5000"
Example
{
"limit": "integer",
"timeout": "integer"
}
path_schema:
Path parameters configuration
- secondary-frequency: object
-
Frequency to be used if path failure condition is detected
-
- frequency: integer
-
Frequency value in seconds
range:"1..604800" units:"second" default:"60" - type: string connection-loss, timeout, both
-
Condition type of path failure
- retry: integer
-
Number of attempts before declaring the path as down
range:"0..100" default:"1"
Example
{
"secondary-frequency": {
"frequency": "integer",
"type": "string"
},
"retry": "integer"
}
secondary-frequency_schema:
Frequency to be used if path failure condition is detected
- frequency: integer
-
Frequency value in seconds
range:"1..604800" units:"second" default:"60" - type: string connection-loss, timeout, both
-
Condition type of path failure
Example
{
"frequency": "integer",
"type": "string"
}
echo_schema:
Echo parameters configuration
- maximum-lsp-selector: string
-
Maximum IPv4 address used as destination in echo request
- multipath: object
-
Downstream map multipath settings
-
- bitmap-size: integer
-
Multipath bit size
range:"1..256" default:"32"
- retry: integer
-
Number of timeout retry attempts during path discovery
range:"0..100" default:"1" - timeout: integer
-
Timeout value for echo requests during path discovery
range:"1..600000" units:"millisecond" default:"5000" - interval: integer
-
Send interval between echo requests during path discovery
units:"minute" default:"240"
Example
{
"maximum-lsp-selector": "string",
"multipath": {
"bitmap-size": "integer"
},
"retry": "integer",
"timeout": "integer",
"interval": "integer"
}
multipath_schema:
Downstream map multipath settings
- bitmap-size: integer
-
Multipath bit size
range:"1..256" default:"32"
Example
{
"bitmap-size": "integer"
}
operation_schema:
IPSLA Operation configuration
- reaction-triggers: object
-
Reaction trigger configuration
-
- reaction-trigger: object[]
-
Reaction trigger for an operation
-
object - triggered-op-id: integer
-
Operation number of the operation to be triggered
range:"1..2048" - operation-id: integer
-
Operation number of the operation generating a trigger
range:"1..2048"
- reactions: object
-
Reaction configuration
-
- reaction: object[]
-
Reaction configuration for an operation
-
object - condition: object
-
Reaction condition specification
-
- timeout: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on probe timeout
- jitter-average-ds: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on destination to source jitter threshold violation
- rtt: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on round trip time threshold violation
- packet-loss-ds: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on source to destination packet loss threshold violation
- jitter-average-sd: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on average source to destination jitter threshold violation
- packet-loss-sd: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on destination to source packet loss threshold violation
- jitter-average: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on average round trip jitter threshold violation
- verify-error: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on error verfication violation
- connection-loss: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on connection loss for a monitored operation
- operation-id: integer
-
Operation number
range:"1..2048"
- definitions: object
-
Operation definition table
-
- definition: object[]
-
Operation definition
-
object - operation-type: object
-
Operation type specification
-
- udp-echo:
-
UDPEcho Operation type
- icmp-path-jitter:
-
ICMPPathJitter Operation type
- udp-jitter:
-
UDPJitter Operation type
- icmp-echo:
-
ICMPEcho Operation type
- mpls-lsp-trace:
-
MPLS LSP Trace Operation type
- icmp-path-echo:
-
ICMPPathEcho Operation type
- mpls-lsp-ping:
-
MPLS LSP Ping Operation type
- operation-id: integer
-
Operation number
range:"1..2048"
- schedules: object
-
Schedule an operation
-
- schedule: object[]
-
Operation schedule configuration
-
object - ageout: integer
-
How long to keep this entry after it becomes inactive
range:"0..2073600" units:"second" - life: string
-
Length of the time to execute (default 3600 seconds)
- recurring: null
-
probe to be scheduled automatically every day
- start-time: object
-
Start time of the operation
-
- hour: integer
-
Hour value(hh) in hh:mm:ss specification
range:"0..23" - month: string january, february, march, april, may, june, july, august, september, october, november, december
-
Month of the year (optional. Default current month)
- second: integer
-
Second value(ss) in hh:mm:ss specification
range:"0..59" - schedule-type: string pending, now, after, at
-
Type of schedule
- year: integer
-
Year(optional. Default current year)
range:"1993..2035" - day: integer
-
Day of the month(optional. Default today)
range:"1..31" - minute: integer
-
Minute value(mm) in hh:mm:ss specification
range:"0..59"
- operation-id: integer
-
Operation number
range:"1..2048"
Example
{
"reaction-triggers": {
"reaction-trigger": [
{
"triggered-op-id": "integer",
"operation-id": "integer"
}
]
},
"reactions": {
"reaction": [
{
"condition": {
"timeout": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average-ds": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"rtt": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"packet-loss-ds": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average-sd": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"packet-loss-sd": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"verify-error": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"connection-loss": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
]
},
"definitions": {
"definition": [
{
"operation-type": {
"udp-echo": {
"data-size": {
"request": "integer"
},
"tag": "string"
},
"icmp-path-jitter": {
"data-size": {
"request": "integer"
},
"packet": {
"count": "integer",
"interval": "integer"
},
"tag": "string"
},
"udp-jitter": {
"data-size": {
"request": "integer"
},
"packet": {
"count": "integer",
"interval": "integer"
},
"tag": "string"
},
"icmp-echo": {
"tag": "string"
}
}
}
]
}
}
threshold-limits_schema:
Specify threshold limits for the monitored element
- upper-limit: integer
-
Threshold upper limit value
range:"1..4294967295" - lower-limit: integer
-
Threshold lower limit value
range:"1..4294967295"
Example
{
"upper-limit": "integer",
"lower-limit": "integer"
}
reaction-triggers_schema:
Reaction trigger configuration
- reaction-trigger: object[]
-
Reaction trigger for an operation
-
object - triggered-op-id: integer
-
Operation number of the operation to be triggered
range:"1..2048" - operation-id: integer
-
Operation number of the operation generating a trigger
range:"1..2048"
Example
{
"reaction-trigger": [
{
"triggered-op-id": "integer",
"operation-id": "integer"
}
]
}
reaction-trigger_schema:
- triggered-op-id: integer
-
Operation number of the operation to be triggered
range:"1..2048" - operation-id: integer
-
Operation number of the operation generating a trigger
range:"1..2048"
Example
{
"triggered-op-id": "integer",
"operation-id": "integer"
}
icmp-echo_schema:
ICMPEcho Operation type
- data-size: object
-
Protocol data size in payload of probe packets
-
- request: integer
-
Payload size in request probe packet
range:"0..16384" units:"byte" default:"100"
- source-address-v6: string
-
Enter IPv6 address of the source device
- dest-address-v6: string
-
Enter IPv6 address of the destination device
Example
{
"data-size": {
"request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
}
history_schema:
Configure the history parameters for this operation
- buckets: integer
-
Specify number of history buckets
range:"1..60" default:"15" - lives: integer
-
Specify number of lives to be kept
range:"0..2" default:"0" - history-filter: string failed, all
-
Choose type of data to be stored in history buffer
- samples: integer
-
Specify number of samples to keep
range:"1..30" default:"16"
Example
{
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
}
enhanced-stats_schema:
Table of statistics collection intervals
- enhanced-stat: object[]
-
Statistics for a specified time interval
-
object - buckets: integer
-
Buckets of enhanced statistics kept
range:"1..60" default:"15" - interval: integer
-
Interval in seconds
units:"minute" default:"240"
Example
{
"enhanced-stat": [
{
"buckets": "integer",
"interval": "integer"
}
]
}
enhanced-stat_schema:
- buckets: integer
-
Buckets of enhanced statistics kept
range:"1..60" default:"15" - interval: integer
-
Interval in seconds
units:"minute" default:"240"
Example
{
"buckets": "integer",
"interval": "integer"
}
target_schema:
Target for the MPLS LSP operation
- ipv4: object
-
Target specified as an IPv4 address
-
- fec-address: object
-
Target FEC address with mask
-
- mask: string
-
IP netmask for target
- address: string
-
IP address for target
- traffic-engineering: object
-
Traffic engineering target
-
- tunnel: integer
-
Tunnel interface number
range:"0..65535"
Example
{
"ipv4": {
"fec-address": {
"mask": "string",
"address": "string"
}
},
"traffic-engineering": {
"tunnel": "integer"
}
}
traffic-engineering_schema:
Traffic engineering target
- tunnel: integer
-
Tunnel interface number
range:"0..65535"
Example
{
"tunnel": "integer"
}
ipv4_schema:
Target specified as an IPv4 address
- fec-address: object
-
Target FEC address with mask
-
- mask: string
-
IP netmask for target
- address: string
-
IP address for target
Example
{
"fec-address": {
"mask": "string",
"address": "string"
}
}
fec-address_schema:
Target FEC address with mask
- mask: string
-
IP netmask for target
- address: string
-
IP address for target
Example
{
"mask": "string",
"address": "string"
}
pseudowire_schema:
Pseudowire target
- target-address: object
-
Target address
-
- vc-id: integer
-
Virtual circuit ID
range:"1..4294967295" - address: string
-
Target address
Example
{
"target-address": {
"vc-id": "integer",
"address": "string"
}
}
target-address_schema:
Target address
- vc-id: integer
-
Virtual circuit ID
range:"1..4294967295" - address: string
-
Target address
Example
{
"vc-id": "integer",
"address": "string"
}
udp-echo_schema:
UDPEcho Operation type
- data-size: object
-
Protocol data size in payload of probe packets
-
- request: integer
-
Payload size in request probe packet
range:"0..16384" units:"byte" default:"100"
Example
{
"data-size": {
"request": "integer"
},
"tag": "string"
}
udp-jitter_schema:
UDPJitter Operation type
- data-size: object
-
Protocol data size in payload of probe packets
-
- request: integer
-
Payload size in request probe packet
range:"0..16384" units:"byte" default:"100"
- packet: object
-
Probe packet stream configuration parameters
-
- count: integer
-
Number of packets to be transmitted during a probe
range:"1..100" default:"10" - interval: integer
-
Packet interval in milliseconds
units:"minute" default:"240"
Example
{
"data-size": {
"request": "integer"
},
"packet": {
"count": "integer",
"interval": "integer"
},
"tag": "string"
}
packet_schema:
Probe packet stream configuration parameters
- count: integer
-
Number of packets to be transmitted during a probe
range:"1..100" default:"10" - interval: integer
-
Packet interval in milliseconds
units:"minute" default:"240"
Example
{
"count": "integer",
"interval": "integer"
}
icmp-path-echo_schema:
ICMPPathEcho Operation type
- statistics: object
-
Statistics collection aggregated over an hour
-
- dist-count: integer
-
Count of distribution intervals maintained
range:"1..20" default:"1" - paths: integer
-
Maximum number of paths for which statistics are kept
range:"1..128" default:"5" - hops: integer
-
Maximum hops per path for which statistics are kept
range:"1..30" default:"16" - hours: integer
-
Number of hours for which hourly statistics are kept
range:"0..25" units:"hour" default:"2" - dist-interval: integer
-
Specify distribution interval in milliseconds
range:"1..100" units:"millisecond" default:"20"
- data-size: object
-
Protocol data size in payload of probe packets
-
- request: integer
-
Payload size in request probe packet
range:"0..16384" units:"byte" default:"100"
- history: object
-
Configure the history parameters for this operation
-
- buckets: integer
-
Specify number of history buckets
range:"1..60" default:"15" - lives: integer
-
Specify number of lives to be kept
range:"0..2" default:"0" - history-filter: string failed, all
-
Choose type of data to be stored in history buffer
- samples: integer
-
Specify number of samples to keep
range:"1..30" default:"16"
Example
{
"statistics": {
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
},
"data-size": {
"request": "integer"
},
"history": {
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}
lsr-path_schema:
Loose source routing path (up to 8 intermediate nodes)
- node8: string
-
IPv4 address of the intermediate node
- node1: string
-
IPv4 address of the intermediate node
- node3: string
-
IPv4 address of the intermediate node
- node2: string
-
IPv4 address of the intermediate node
- node5: string
-
IPv4 address of the intermediate node
- node4: string
-
IPv4 address of the intermediate node
- node7: string
-
IPv4 address of the intermediate node
- node6: string
-
IPv4 address of the intermediate node
Example
{
"node8": "string",
"node1": "string",
"node3": "string",
"node2": "string",
"node5": "string",
"node4": "string",
"node7": "string",
"node6": "string"
}
icmp-path-jitter_schema:
ICMPPathJitter Operation type
- data-size: object
-
Protocol data size in payload of probe packets
-
- request: integer
-
Payload size in request probe packet
range:"0..16384" units:"byte" default:"100"
- packet: object
-
Probe packet stream configuration parameters
-
- count: integer
-
Number of packets to be transmitted during a probe
range:"1..100" default:"10" - interval: integer
-
Packet interval in milliseconds
units:"minute" default:"240"
Example
{
"data-size": {
"request": "integer"
},
"packet": {
"count": "integer",
"interval": "integer"
},
"tag": "string"
}
responder_schema:
Responder configuration
- twamp: object
-
Responder TWAMP configuration
-
- timeout: integer
-
Configure responder timeout value in seconds
range:"1..600000" units:"millisecond" default:"5000"
- type: object
-
Configure IPSLA Responder port type
-
- udp: object
-
Configure IPSLA Responder UDP address and port
-
- addresses: object
-
Configure IP address
-
- address: object[]
-
Configure IP address for the permanent port
-
object - local-address: string
-
IP address of the Responder
- ports: object
-
Configure port
-
- port: object[]
-
Configure port number for the permanent port
-
object - port: string
-
Port number to be enabled
Example
{
"twamp": {
"timeout": "integer"
},
"type": {
"udp": {
"addresses": {
"address": [
{
"local-address": "string",
"ports": {
"port": [
{
"port": "string"
}
]
}
}
]
}
}
}
}
twamp_schema:
Responder TWAMP configuration
- timeout: integer
-
Configure responder timeout value in seconds
range:"1..600000" units:"millisecond" default:"5000"
Example
{
"timeout": "integer"
}
type_schema:
Configure IPSLA Responder port type
- udp: object
-
Configure IPSLA Responder UDP address and port
-
- addresses: object
-
Configure IP address
-
- address: object[]
-
Configure IP address for the permanent port
-
object - local-address: string
-
IP address of the Responder
- ports: object
-
Configure port
-
- port: object[]
-
Configure port number for the permanent port
-
object - port: string
-
Port number to be enabled
Example
{
"udp": {
"addresses": {
"address": [
{
"local-address": "string",
"ports": {
"port": [
{
"port": "string"
}
]
}
}
]
}
}
}
udp_schema:
Configure IPSLA Responder UDP address and port
- addresses: object
-
Configure IP address
-
- address: object[]
-
Configure IP address for the permanent port
-
object - local-address: string
-
IP address of the Responder
- ports: object
-
Configure port
-
- port: object[]
-
Configure port number for the permanent port
-
object - port: string
-
Port number to be enabled
Example
{
"addresses": {
"address": [
{
"local-address": "string",
"ports": {
"port": [
{
"port": "string"
}
]
}
}
]
}
}
addresses_schema:
Configure IP address
- address: object[]
-
Configure IP address for the permanent port
-
object - local-address: string
-
IP address of the Responder
- ports: object
-
Configure port
-
- port: object[]
-
Configure port number for the permanent port
-
object - port: string
-
Port number to be enabled
Example
{
"address": [
{
"local-address": "string",
"ports": {
"port": [
{
"port": "string"
}
]
}
}
]
}
address_schema:
- local-address: string
-
IP address of the Responder
- ports: object
-
Configure port
-
- port: object[]
-
Configure port number for the permanent port
-
object - port: string
-
Port number to be enabled
Example
{
"local-address": "string",
"ports": {
"port": [
{
"port": "string"
}
]
}
}
ports_schema:
Configure port
- port: object[]
-
Configure port number for the permanent port
-
object - port: string
-
Port number to be enabled
Example
{
"port": [
{
"port": "string"
}
]
}
mpls-discovery_schema:
Provider Edge(PE) discovery configuration
- vpn: object
-
Layer 3 VPN PE discovery configuration
-
- interval: integer
-
Specify a discovery refresh interval
units:"minute" default:"240"
Example
{
"vpn": {
"interval": "integer"
}
}
vpn_schema:
Layer 3 VPN PE discovery configuration
- interval: integer
-
Specify a discovery refresh interval
units:"minute" default:"240"
Example
{
"interval": "integer"
}
server-twamp_schema:
IPPM Server configuration
- inactivity-timer: integer
-
Configure ippmserver inactivity timer value in seconds
range:"1..6000" units:"second" default:"900" - port: string
-
Configure port number for ippmserver listening port
Example
{
"inactivity-timer": "integer",
"port": "string"
}
a1_ipsla_schema:
IPSLA configuration
- responder: object
-
Responder configuration
-
- twamp: object
-
Responder TWAMP configuration
-
- timeout: integer
-
Configure responder timeout value in seconds
range:"1..600000" units:"millisecond" default:"5000"
- type: object
-
Configure IPSLA Responder port type
-
- udp: object
-
Configure IPSLA Responder UDP address and port
-
- addresses: object
-
Configure IP address
-
- address: object[]
-
Configure IP address for the permanent port
-
object - local-address: string
-
IP address of the Responder
- ports: object
-
Configure port
-
- port: object[]
-
Configure port number for the permanent port
-
object - port: string
-
Port number to be enabled
- mpls-lsp-monitor: object
-
MPLS LSP Monitor(MPLSLM) configuration
-
- reactions: object
-
MPLSLM Reaction configuration
-
- reaction: object[]
-
Reaction configuration for an MPLSLM instance
-
object - condition: object
-
Reaction condition specification
-
- lpd-tree-trace: IPSLA-MPLSLM-REACT-CFG-CREATE
-
React on LPD Tree Trace violation for a monitored MPLSLM
- lpd-group: IPSLA-MPLSLM-REACT-CFG-CREATE
-
React on LPD Group violation for a monitored MPLSLM
- timeout: IPSLA-MPLSLM-REACT-CFG-CREATE
-
React on probe timeout
- connection-loss: IPSLA-MPLSLM-REACT-CFG-CREATE
-
React on connection loss for a monitored MPLSLM
- monitor-id: integer
-
Monitor identifier
range:"1..2048"
- definitions: object
-
MPLS LSP Monitor definition table
-
- definition: object[]
-
MPLS LSP Monitor definition
-
object - operation-type: object
-
Operation type specification
-
- mpls-lsp-trace:
-
Perform MPLS LSP Trace operation
- mpls-lsp-ping:
-
Perform MPLS LSP Ping operation
- monitor-id: integer
-
Monitor identifier
range:"1..2048"
- schedules: object
-
MPLSLM schedule configuration
-
- schedule: object[]
-
Schedule an MPLSLM instance
-
object - frequency: integer
-
Group schedule frequency of the probing
range:"1..604800" units:"second" default:"60" - start-time: object
-
Start time of MPLSLM instance
-
- hour: integer
-
Hour value(hh) in hh:mm:ss specification
range:"0..23" - month: string january, february, march, april, may, june, july, august, september, october, november, december
-
Month of the year (optional. Default current month)
- second: integer
-
Second value(ss) in hh:mm:ss specification
range:"0..59" - schedule-type: string pending, now, after, at
-
Type of schedule
- year: integer
-
Year (optional. Default current year)
range:"1993..2035" - day: integer
-
Day of the month(optional. Default today)
range:"1..31" - minute: integer
-
Minute value(mm) in hh:mm:ss specification
range:"0..59"
- period: integer
-
Group schedule period range
range:"1..604800" units:"second" - monitor-id: integer
-
Monitor indentifier
range:"1..2048"
- common: object
-
IPSLA application common configuration
-
- low-memory: integer
-
Configure low memory water mark (default 20M)
range:"0..4294967295" default:20M)" - authentication: object
-
Authenticaion configuration
-
- key-chain: string
-
Use MD5 authentication for IPSLA control message
- hardware-timestamp: object
-
Hardware Timestamp configuration
-
- disable: null
-
states true if hw-timestamp is disabled
- server-twamp: object
-
IPPM Server configuration
-
- inactivity-timer: integer
-
Configure ippmserver inactivity timer value in seconds
range:"1..6000" units:"second" default:"900" - port: string
-
Configure port number for ippmserver listening port
- operation: object
-
IPSLA Operation configuration
-
- reaction-triggers: object
-
Reaction trigger configuration
-
- reaction-trigger: object[]
-
Reaction trigger for an operation
-
object - triggered-op-id: integer
-
Operation number of the operation to be triggered
range:"1..2048" - operation-id: integer
-
Operation number of the operation generating a trigger
range:"1..2048"
- reactions: object
-
Reaction configuration
-
- reaction: object[]
-
Reaction configuration for an operation
-
object - condition: object
-
Reaction condition specification
-
- timeout: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on probe timeout
- jitter-average-ds: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on destination to source jitter threshold violation
- rtt: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on round trip time threshold violation
- packet-loss-ds: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on source to destination packet loss threshold violation
- jitter-average-sd: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on average source to destination jitter threshold violation
- packet-loss-sd: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on destination to source packet loss threshold violation
- jitter-average: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on average round trip jitter threshold violation
- verify-error: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on error verfication violation
- connection-loss: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on connection loss for a monitored operation
- operation-id: integer
-
Operation number
range:"1..2048"
- definitions: object
-
Operation definition table
-
- definition: object[]
-
Operation definition
-
object - operation-type: object
-
Operation type specification
-
- udp-echo:
-
UDPEcho Operation type
- icmp-path-jitter:
-
ICMPPathJitter Operation type
- udp-jitter:
-
UDPJitter Operation type
- icmp-echo:
-
ICMPEcho Operation type
- mpls-lsp-trace:
-
MPLS LSP Trace Operation type
- icmp-path-echo:
-
ICMPPathEcho Operation type
- mpls-lsp-ping:
-
MPLS LSP Ping Operation type
- operation-id: integer
-
Operation number
range:"1..2048"
- schedules: object
-
Schedule an operation
-
- schedule: object[]
-
Operation schedule configuration
-
object - ageout: integer
-
How long to keep this entry after it becomes inactive
range:"0..2073600" units:"second" - life: string
-
Length of the time to execute (default 3600 seconds)
- recurring: null
-
probe to be scheduled automatically every day
- start-time: object
-
Start time of the operation
-
- hour: integer
-
Hour value(hh) in hh:mm:ss specification
range:"0..23" - month: string january, february, march, april, may, june, july, august, september, october, november, december
-
Month of the year (optional. Default current month)
- second: integer
-
Second value(ss) in hh:mm:ss specification
range:"0..59" - schedule-type: string pending, now, after, at
-
Type of schedule
- year: integer
-
Year(optional. Default current year)
range:"1993..2035" - day: integer
-
Day of the month(optional. Default today)
range:"1..31" - minute: integer
-
Minute value(mm) in hh:mm:ss specification
range:"0..59"
- operation-id: integer
-
Operation number
range:"1..2048"
- mpls-discovery: object
-
Provider Edge(PE) discovery configuration
-
- vpn: object
-
Layer 3 VPN PE discovery configuration
-
- interval: integer
-
Specify a discovery refresh interval
units:"minute" default:"240"
Example
{
"responder": {
"twamp": {
"timeout": "integer"
},
"type": {
"udp": {
"addresses": {
"address": [
{
"local-address": "string",
"ports": {
"port": [
{
"port": "string"
}
]
}
}
]
}
}
}
},
"mpls-lsp-monitor": {
"reactions": {
"reaction": [
{
"condition": {
"lpd-tree-trace": {
"create": [ null ]
},
"lpd-group": {
"create": [ null ]
},
"timeout": {
"create": [ null ]
},
"connection-loss": {
"create": [ null ]
}
},
"monitor-id": "integer"
}
]
},
"definitions": {
"definition": [
{
"operation-type": {
"mpls-lsp-trace": {
"ttl": "integer",
"vrf": "string"
},
"mpls-lsp-ping": {
"data-size": {
"request": "integer"
},
"path-discover": {
"path": {
"secondary-frequency": {
"frequency": "integer",
"type": "string"
},
"retry": "integer"
},
"create": [ null ],
"session": {
"limit": "integer",
"timeout": "integer"
},
"scan-period": "integer",
"echo": {
"maximum-lsp-selector": "string",
"multipath": {
"bitmap-size": "integer"
},
"retry": "integer",
"timeout": "integer",
"interval": "integer"
}
},
"ttl": "integer",
"vrf": "string"
}
},
"monitor-id": "integer"
}
]
},
"schedules": {
"schedule": [
{
"frequency": "integer",
"start-time": {
"hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"period": "integer",
"monitor-id": "integer"
}
]
}
},
"common": {
"low-memory": "integer",
"authentication": {
"key-chain": "string"
},
"hardware-timestamp": {
"disable": [ null ]
}
},
"server-twamp": {
"inactivity-timer": "integer",
"port": "string"
},
"operation": {
"reaction-triggers": {
"reaction-trigger": [
{
"triggered-op-id": "integer",
"operation-id": "integer"
}
]
},
"reactions": {
"reaction": [ null ]
}
}
}
a1_common_schema:
IPSLA application common configuration
- low-memory: integer
-
Configure low memory water mark (default 20M)
range:"0..4294967295" default:20M)" - authentication: object
-
Authenticaion configuration
-
- key-chain: string
-
Use MD5 authentication for IPSLA control message
- hardware-timestamp: object
-
Hardware Timestamp configuration
-
- disable: null
-
states true if hw-timestamp is disabled
Example
{
"low-memory": "integer",
"authentication": {
"key-chain": "string"
},
"hardware-timestamp": {
"disable": [ null ]
}
}
a1_hardware-timestamp_schema:
Hardware Timestamp configuration
- disable: null
-
states true if hw-timestamp is disabled
Example
{
"disable": [ null ]
}
a1_authentication_schema:
Authenticaion configuration
- key-chain: string
-
Use MD5 authentication for IPSLA control message
Example
{
"key-chain": "string"
}
a1_mpls-lsp-monitor_schema:
MPLS LSP Monitor(MPLSLM) configuration
- reactions: object
-
MPLSLM Reaction configuration
-
- reaction: object[]
-
Reaction configuration for an MPLSLM instance
-
object - condition: object
-
Reaction condition specification
-
- lpd-tree-trace: IPSLA-MPLSLM-REACT-CFG-CREATE
-
React on LPD Tree Trace violation for a monitored MPLSLM
- lpd-group: IPSLA-MPLSLM-REACT-CFG-CREATE
-
React on LPD Group violation for a monitored MPLSLM
- timeout: IPSLA-MPLSLM-REACT-CFG-CREATE
-
React on probe timeout
- connection-loss: IPSLA-MPLSLM-REACT-CFG-CREATE
-
React on connection loss for a monitored MPLSLM
- monitor-id: integer
-
Monitor identifier
range:"1..2048"
- definitions: object
-
MPLS LSP Monitor definition table
-
- definition: object[]
-
MPLS LSP Monitor definition
-
object - operation-type: object
-
Operation type specification
-
- mpls-lsp-trace:
-
Perform MPLS LSP Trace operation
- mpls-lsp-ping:
-
Perform MPLS LSP Ping operation
- monitor-id: integer
-
Monitor identifier
range:"1..2048"
- schedules: object
-
MPLSLM schedule configuration
-
- schedule: object[]
-
Schedule an MPLSLM instance
-
object - frequency: integer
-
Group schedule frequency of the probing
range:"1..604800" units:"second" default:"60" - start-time: object
-
Start time of MPLSLM instance
-
- hour: integer
-
Hour value(hh) in hh:mm:ss specification
range:"0..23" - month: string january, february, march, april, may, june, july, august, september, october, november, december
-
Month of the year (optional. Default current month)
- second: integer
-
Second value(ss) in hh:mm:ss specification
range:"0..59" - schedule-type: string pending, now, after, at
-
Type of schedule
- year: integer
-
Year (optional. Default current year)
range:"1993..2035" - day: integer
-
Day of the month(optional. Default today)
range:"1..31" - minute: integer
-
Minute value(mm) in hh:mm:ss specification
range:"0..59"
- period: integer
-
Group schedule period range
range:"1..604800" units:"second" - monitor-id: integer
-
Monitor indentifier
range:"1..2048"
Example
{
"reactions": {
"reaction": [
{
"condition": {
"lpd-tree-trace": {
"create": [ null ]
},
"lpd-group": {
"create": [ null ]
},
"timeout": {
"create": [ null ]
},
"connection-loss": {
"create": [ null ]
}
},
"monitor-id": "integer"
}
]
},
"definitions": {
"definition": [
{
"operation-type": {
"mpls-lsp-trace": {
"ttl": "integer",
"vrf": "string"
},
"mpls-lsp-ping": {
"data-size": {
"request": "integer"
},
"path-discover": {
"path": {
"secondary-frequency": {
"frequency": "integer",
"type": "string"
},
"retry": "integer"
},
"create": [ null ],
"session": {
"limit": "integer",
"timeout": "integer"
},
"scan-period": "integer",
"echo": {
"maximum-lsp-selector": "string",
"multipath": {
"bitmap-size": "integer"
},
"retry": "integer",
"timeout": "integer",
"interval": "integer"
}
},
"ttl": "integer",
"vrf": "string"
}
},
"monitor-id": "integer"
}
]
},
"schedules": {
"schedule": [
{
"frequency": "integer",
"start-time": {
"hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"period": "integer",
"monitor-id": "integer"
}
]
}
}
a1_reactions_schema:
Reaction configuration
- reaction: object[]
-
Reaction configuration for an operation
-
object - condition: object
-
Reaction condition specification
-
- timeout: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on probe timeout
- jitter-average-ds: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on destination to source jitter threshold violation
- rtt: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on round trip time threshold violation
- packet-loss-ds: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on source to destination packet loss threshold violation
- jitter-average-sd: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on average source to destination jitter threshold violation
- packet-loss-sd: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on destination to source packet loss threshold violation
- jitter-average: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on average round trip jitter threshold violation
- verify-error: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on error verfication violation
- connection-loss: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on connection loss for a monitored operation
- operation-id: integer
-
Operation number
range:"1..2048"
Example
{
"reaction": [
{
"condition": {
"timeout": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average-ds": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"rtt": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"packet-loss-ds": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average-sd": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"packet-loss-sd": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"verify-error": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"connection-loss": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
]
}
a1_reaction_schema:
- condition: object
-
Reaction condition specification
-
- timeout: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on probe timeout
- jitter-average-ds: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on destination to source jitter threshold violation
- rtt: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on round trip time threshold violation
- packet-loss-ds: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on source to destination packet loss threshold violation
- jitter-average-sd: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on average source to destination jitter threshold violation
- packet-loss-sd: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on destination to source packet loss threshold violation
- jitter-average: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on average round trip jitter threshold violation
- verify-error: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on error verfication violation
- connection-loss: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on connection loss for a monitored operation
- operation-id: integer
-
Operation number
range:"1..2048"
Example
{
"condition": {
"timeout": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average-ds": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"rtt": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"packet-loss-ds": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average-sd": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"packet-loss-sd": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"verify-error": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"connection-loss": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
a1_condition_schema:
Reaction condition specification
- timeout: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on probe timeout
- jitter-average-ds: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on destination to source jitter threshold violation
- rtt: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on round trip time threshold violation
- packet-loss-ds: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on source to destination packet loss threshold violation
- jitter-average-sd: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on average source to destination jitter threshold violation
- packet-loss-sd: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on destination to source packet loss threshold violation
- jitter-average: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on average round trip jitter threshold violation
- verify-error: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on error verfication violation
- connection-loss: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on connection loss for a monitored operation
Example
{
"timeout": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average-ds": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"rtt": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"packet-loss-ds": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average-sd": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"packet-loss-sd": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"verify-error": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"connection-loss": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
}
a1_action-type_schema:
Type of action to be taken on threshold violation(s)
- trigger: null
-
Generate trigger to active reaction triggered operation(s)
- logging: null
-
Generate a syslog alarm on threshold violation
Example
{
"trigger": [ null ],
"logging": [ null ]
}
a1_threshold-type_schema:
Type of thresholding to perform on the monitored element
- thresh-type: string immediate, consecutive, xof-y, average
-
Type of thresholding to perform
- count1: integer
-
Probe count for avarage, consecutive case or X value for XofY case
range:"1..16" - count2: integer
-
Y value, when threshold type is XofY
range:"1..16"
Example
{
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
a1_schedules_schema:
Schedule an operation
- schedule: object[]
-
Operation schedule configuration
-
object - ageout: integer
-
How long to keep this entry after it becomes inactive
range:"0..2073600" units:"second" - life: string
-
Length of the time to execute (default 3600 seconds)
- recurring: null
-
probe to be scheduled automatically every day
- start-time: object
-
Start time of the operation
-
- hour: integer
-
Hour value(hh) in hh:mm:ss specification
range:"0..23" - month: string january, february, march, april, may, june, july, august, september, october, november, december
-
Month of the year (optional. Default current month)
- second: integer
-
Second value(ss) in hh:mm:ss specification
range:"0..59" - schedule-type: string pending, now, after, at
-
Type of schedule
- year: integer
-
Year(optional. Default current year)
range:"1993..2035" - day: integer
-
Day of the month(optional. Default today)
range:"1..31" - minute: integer
-
Minute value(mm) in hh:mm:ss specification
range:"0..59"
- operation-id: integer
-
Operation number
range:"1..2048"
Example
{
"schedule": [
{
"ageout": "integer",
"life": "string",
"recurring": [ null ],
"start-time": {
"hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"operation-id": "integer"
}
]
}
a1_schedule_schema:
- ageout: integer
-
How long to keep this entry after it becomes inactive
range:"0..2073600" units:"second" - life: string
-
Length of the time to execute (default 3600 seconds)
- recurring: null
-
probe to be scheduled automatically every day
- start-time: object
-
Start time of the operation
-
- hour: integer
-
Hour value(hh) in hh:mm:ss specification
range:"0..23" - month: string january, february, march, april, may, june, july, august, september, october, november, december
-
Month of the year (optional. Default current month)
- second: integer
-
Second value(ss) in hh:mm:ss specification
range:"0..59" - schedule-type: string pending, now, after, at
-
Type of schedule
- year: integer
-
Year(optional. Default current year)
range:"1993..2035" - day: integer
-
Day of the month(optional. Default today)
range:"1..31" - minute: integer
-
Minute value(mm) in hh:mm:ss specification
range:"0..59"
- operation-id: integer
-
Operation number
range:"1..2048"
Example
{
"ageout": "integer",
"life": "string",
"recurring": [ null ],
"start-time": {
"hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
},
"operation-id": "integer"
}
a1_start-time_schema:
Start time of the operation
- hour: integer
-
Hour value(hh) in hh:mm:ss specification
range:"0..23" - month: string january, february, march, april, may, june, july, august, september, october, november, december
-
Month of the year (optional. Default current month)
- second: integer
-
Second value(ss) in hh:mm:ss specification
range:"0..59" - schedule-type: string pending, now, after, at
-
Type of schedule
- year: integer
-
Year(optional. Default current year)
range:"1993..2035" - day: integer
-
Day of the month(optional. Default today)
range:"1..31" - minute: integer
-
Minute value(mm) in hh:mm:ss specification
range:"0..59"
Example
{
"hour": "integer",
"month": "string",
"second": "integer",
"schedule-type": "string",
"year": "integer",
"day": "integer",
"minute": "integer"
}
a1_definitions_schema:
Operation definition table
- definition: object[]
-
Operation definition
-
object - operation-type: object
-
Operation type specification
-
- udp-echo:
-
UDPEcho Operation type
- icmp-path-jitter:
-
ICMPPathJitter Operation type
- udp-jitter:
-
UDPJitter Operation type
- icmp-echo:
-
ICMPEcho Operation type
- mpls-lsp-trace:
-
MPLS LSP Trace Operation type
- icmp-path-echo:
-
ICMPPathEcho Operation type
- mpls-lsp-ping:
-
MPLS LSP Ping Operation type
- operation-id: integer
-
Operation number
range:"1..2048"
Example
{
"definition": [
{
"operation-type": {
"udp-echo": {
"data-size": {
"request": "integer"
},
"tag": "string"
},
"icmp-path-jitter": {
"data-size": {
"request": "integer"
},
"packet": {
"count": "integer",
"interval": "integer"
},
"tag": "string"
},
"udp-jitter": {
"data-size": {
"request": "integer"
},
"packet": {
"count": "integer",
"interval": "integer"
},
"tag": "string"
},
"icmp-echo": {
"data-size": {
"request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
},
"mpls-lsp-trace": {
"reply": {
"mode": "string",
"dscp-bits": "string"
},
"target": {
"ipv4": {
"fec-address": {
"mask": "string",
"address": "string"
}
},
"traffic-engineering": {
"tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
},
"icmp-path-echo": {
"statistics": {
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
},
"data-size": {
"request": "integer"
},
"history": {
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
},
"mpls-lsp-ping": {
"reply": {
"mode": "string",
"dscp-bits": "string"
},
"data-size": {
"request": "integer"
},
"target": {
"pseudowire": {
"target-address": {
"vc-id": "integer",
"address": "string"
}
},
"ipv4": {
"fec-address": {
"mask": "string",
"address": "string"
}
},
"traffic-engineering": {}
},
"tag": "string"
}
}
}
]
}
a1_definition_schema:
- operation-type: object
-
Operation type specification
-
- udp-echo:
-
UDPEcho Operation type
- icmp-path-jitter:
-
ICMPPathJitter Operation type
- udp-jitter:
-
UDPJitter Operation type
- icmp-echo:
-
ICMPEcho Operation type
- mpls-lsp-trace:
-
MPLS LSP Trace Operation type
- icmp-path-echo:
-
ICMPPathEcho Operation type
- mpls-lsp-ping:
-
MPLS LSP Ping Operation type
- operation-id: integer
-
Operation number
range:"1..2048"
Example
{
"operation-type": {
"udp-echo": {
"data-size": {
"request": "integer"
},
"tag": "string"
},
"icmp-path-jitter": {
"data-size": {
"request": "integer"
},
"packet": {
"count": "integer",
"interval": "integer"
},
"tag": "string"
},
"udp-jitter": {
"data-size": {
"request": "integer"
},
"packet": {
"count": "integer",
"interval": "integer"
},
"tag": "string"
},
"icmp-echo": {
"data-size": {
"request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
},
"mpls-lsp-trace": {
"reply": {
"mode": "string",
"dscp-bits": "string"
},
"target": {
"ipv4": {
"fec-address": {
"mask": "string",
"address": "string"
}
},
"traffic-engineering": {
"tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
},
"icmp-path-echo": {
"statistics": {
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
},
"data-size": {
"request": "integer"
},
"history": {
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
},
"mpls-lsp-ping": {
"reply": {
"mode": "string",
"dscp-bits": "string"
},
"data-size": {
"request": "integer"
},
"target": {
"pseudowire": {
"target-address": {
"vc-id": "integer",
"address": "string"
}
},
"ipv4": {
"fec-address": {
"mask": "string",
"address": "string"
}
},
"traffic-engineering": {
"tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
}
}
a1_operation-type_schema:
Operation type specification
- udp-echo:
-
UDPEcho Operation type
- icmp-path-jitter:
-
ICMPPathJitter Operation type
- udp-jitter:
-
UDPJitter Operation type
- icmp-echo:
-
ICMPEcho Operation type
- mpls-lsp-trace:
-
MPLS LSP Trace Operation type
- icmp-path-echo:
-
ICMPPathEcho Operation type
- mpls-lsp-ping:
-
MPLS LSP Ping Operation type
Example
{
"udp-echo": {
"data-size": {
"request": "integer"
},
"tag": "string"
},
"icmp-path-jitter": {
"data-size": {
"request": "integer"
},
"packet": {
"count": "integer",
"interval": "integer"
},
"tag": "string"
},
"udp-jitter": {
"data-size": {
"request": "integer"
},
"packet": {
"count": "integer",
"interval": "integer"
},
"tag": "string"
},
"icmp-echo": {
"data-size": {
"request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
},
"mpls-lsp-trace": {
"reply": {
"mode": "string",
"dscp-bits": "string"
},
"target": {
"ipv4": {
"fec-address": {
"mask": "string",
"address": "string"
}
},
"traffic-engineering": {
"tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
},
"icmp-path-echo": {
"statistics": {
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
},
"data-size": {
"request": "integer"
},
"history": {
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
},
"mpls-lsp-ping": {
"reply": {
"mode": "string",
"dscp-bits": "string"
},
"data-size": {
"request": "integer"
},
"target": {
"pseudowire": {
"target-address": {
"vc-id": "integer",
"address": "string"
}
},
"ipv4": {
"fec-address": {
"mask": "string",
"address": "string"
}
},
"traffic-engineering": {
"tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
}
a1_mpls-lsp-trace_schema:
MPLS LSP Trace Operation type
- reply:
-
Echo reply options for the MPLS LSP operation
- target: object
-
Target for the MPLS LSP operation
-
- ipv4: object
-
Target specified as an IPv4 address
-
- fec-address: object
-
Target FEC address with mask
-
- mask: string
-
IP netmask for target
- address: string
-
IP address for target
- traffic-engineering: object
-
Traffic engineering target
-
- tunnel: integer
-
Tunnel interface number
range:"0..65535"
- ttl: integer
-
Time to live value
range:"1..255" default:"30"
Example
{
"reply": {
"mode": "string",
"dscp-bits": "string"
},
"target": {
"ipv4": {
"fec-address": {
"mask": "string",
"address": "string"
}
},
"traffic-engineering": {
"tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
a1_reply_schema:
Echo reply options for the MPLS LSP operation
- mode: string ipv4-udp-router-alert
-
Enables use of router alert in echo reply packets
Example
{
"mode": "string",
"dscp-bits": "string"
}
a1_statistics_schema:
Statistics collection aggregated over an hour
- dist-count: integer
-
Count of distribution intervals maintained
range:"1..20" default:"1" - paths: integer
-
Maximum number of paths for which statistics are kept
range:"1..128" default:"5" - hops: integer
-
Maximum hops per path for which statistics are kept
range:"1..30" default:"16" - hours: integer
-
Number of hours for which hourly statistics are kept
range:"0..25" units:"hour" default:"2" - dist-interval: integer
-
Specify distribution interval in milliseconds
range:"1..100" units:"millisecond" default:"20"
Example
{
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
}
a1_scan_schema:
Scanning parameters configuration
- delete-factor: integer
-
Number of times for automatic deletion
range:"0..2147483647" default:"1" - interval: integer
-
Time interval for automatic discovery
units:"minute" default:"240"
Example
{
"delete-factor": "integer",
"interval": "integer"
}
a1_mpls-lsp-ping_schema:
MPLS LSP Ping Operation type
- reply:
-
Echo reply options for the MPLS LSP operation
- data-size: object
-
Protocol data size in payload of probe packets
-
- request: integer
-
Payload size in request probe packet
range:"0..16384" units:"byte" default:"100"
- target: object
-
Target for the MPLS LSP operation
-
- pseudowire: object
-
Pseudowire target
-
- target-address: object
-
Target address
-
- vc-id: integer
-
Virtual circuit ID
range:"1..4294967295" - address: string
-
Target address
- ipv4: object
-
Target specified as an IPv4 address
-
- fec-address: object
-
Target FEC address with mask
-
- mask: string
-
IP netmask for target
- address: string
-
IP address for target
- traffic-engineering: object
-
Traffic engineering target
-
- tunnel: integer
-
Tunnel interface number
range:"0..65535"
- ttl: integer
-
Time to live value
range:"1..255" default:"30"
Example
{
"reply": {
"mode": "string",
"dscp-bits": "string"
},
"data-size": {
"request": "integer"
},
"target": {
"pseudowire": {
"target-address": {
"vc-id": "integer",
"address": "string"
}
},
"ipv4": {
"fec-address": {
"mask": "string",
"address": "string"
}
},
"traffic-engineering": {
"tunnel": "integer"
}
},
"ttl": "integer",
"tag": "string"
}
a1_data-size_schema:
Protocol data size in payload of probe packets
- request: integer
-
Payload size in request probe packet
range:"0..16384" units:"byte" default:"100"
Example
{
"request": "integer"
}
a1_path-discover_schema:
Path discover configuration
- path: object
-
Path parameters configuration
-
- secondary-frequency: object
-
Frequency to be used if path failure condition is detected
-
- frequency: integer
-
Frequency value in seconds
range:"1..604800" units:"second" default:"60" - type: string connection-loss, timeout, both
-
Condition type of path failure
- retry: integer
-
Number of attempts before declaring the path as down
range:"0..100" default:"1"
- create: null
-
Create LPD instance
- session: object
-
Session parameters configuration
-
- limit: integer
-
Number of concurrent active path discovery requests at one time
range:"1..15" default:"1" - timeout: integer
-
Timeout value for path discovery request
range:"1..600000" units:"millisecond" default:"5000"
- scan-period: integer
-
Time period for finishing path discovery
range:"0..7200" units:"minute" default:"0" - echo: object
-
Echo parameters configuration
-
- maximum-lsp-selector: string
-
Maximum IPv4 address used as destination in echo request
- multipath: object
-
Downstream map multipath settings
-
- bitmap-size: integer
-
Multipath bit size
range:"1..256" default:"32"
- retry: integer
-
Number of timeout retry attempts during path discovery
range:"0..100" default:"1" - timeout: integer
-
Timeout value for echo requests during path discovery
range:"1..600000" units:"millisecond" default:"5000" - interval: integer
-
Send interval between echo requests during path discovery
units:"minute" default:"240"
Example
{
"path": {
"secondary-frequency": {
"frequency": "integer",
"type": "string"
},
"retry": "integer"
},
"create": [ null ],
"session": {
"limit": "integer",
"timeout": "integer"
},
"scan-period": "integer",
"echo": {
"maximum-lsp-selector": "string",
"multipath": {
"bitmap-size": "integer"
},
"retry": "integer",
"timeout": "integer",
"interval": "integer"
}
}
a1_session_schema:
Session parameters configuration
- limit: integer
-
Number of concurrent active path discovery requests at one time
range:"1..15" default:"1" - timeout: integer
-
Timeout value for path discovery request
range:"1..600000" units:"millisecond" default:"5000"
Example
{
"limit": "integer",
"timeout": "integer"
}
a1_path_schema:
Path parameters configuration
- secondary-frequency: object
-
Frequency to be used if path failure condition is detected
-
- frequency: integer
-
Frequency value in seconds
range:"1..604800" units:"second" default:"60" - type: string connection-loss, timeout, both
-
Condition type of path failure
- retry: integer
-
Number of attempts before declaring the path as down
range:"0..100" default:"1"
Example
{
"secondary-frequency": {
"frequency": "integer",
"type": "string"
},
"retry": "integer"
}
a1_secondary-frequency_schema:
Frequency to be used if path failure condition is detected
- frequency: integer
-
Frequency value in seconds
range:"1..604800" units:"second" default:"60" - type: string connection-loss, timeout, both
-
Condition type of path failure
Example
{
"frequency": "integer",
"type": "string"
}
a1_echo_schema:
Echo parameters configuration
- maximum-lsp-selector: string
-
Maximum IPv4 address used as destination in echo request
- multipath: object
-
Downstream map multipath settings
-
- bitmap-size: integer
-
Multipath bit size
range:"1..256" default:"32"
- retry: integer
-
Number of timeout retry attempts during path discovery
range:"0..100" default:"1" - timeout: integer
-
Timeout value for echo requests during path discovery
range:"1..600000" units:"millisecond" default:"5000" - interval: integer
-
Send interval between echo requests during path discovery
units:"minute" default:"240"
Example
{
"maximum-lsp-selector": "string",
"multipath": {
"bitmap-size": "integer"
},
"retry": "integer",
"timeout": "integer",
"interval": "integer"
}
a1_multipath_schema:
Downstream map multipath settings
- bitmap-size: integer
-
Multipath bit size
range:"1..256" default:"32"
Example
{
"bitmap-size": "integer"
}
a1_operation_schema:
IPSLA Operation configuration
- reaction-triggers: object
-
Reaction trigger configuration
-
- reaction-trigger: object[]
-
Reaction trigger for an operation
-
object - triggered-op-id: integer
-
Operation number of the operation to be triggered
range:"1..2048" - operation-id: integer
-
Operation number of the operation generating a trigger
range:"1..2048"
- reactions: object
-
Reaction configuration
-
- reaction: object[]
-
Reaction configuration for an operation
-
object - condition: object
-
Reaction condition specification
-
- timeout: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on probe timeout
- jitter-average-ds: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on destination to source jitter threshold violation
- rtt: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on round trip time threshold violation
- packet-loss-ds: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on source to destination packet loss threshold violation
- jitter-average-sd: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on average source to destination jitter threshold violation
- packet-loss-sd: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on destination to source packet loss threshold violation
- jitter-average: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on average round trip jitter threshold violation
- verify-error: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on error verfication violation
- connection-loss: IPSLA-OP-REACT-CFG-THRESHOLD-TYPE
-
React on connection loss for a monitored operation
- operation-id: integer
-
Operation number
range:"1..2048"
- definitions: object
-
Operation definition table
-
- definition: object[]
-
Operation definition
-
object - operation-type: object
-
Operation type specification
-
- udp-echo:
-
UDPEcho Operation type
- icmp-path-jitter:
-
ICMPPathJitter Operation type
- udp-jitter:
-
UDPJitter Operation type
- icmp-echo:
-
ICMPEcho Operation type
- mpls-lsp-trace:
-
MPLS LSP Trace Operation type
- icmp-path-echo:
-
ICMPPathEcho Operation type
- mpls-lsp-ping:
-
MPLS LSP Ping Operation type
- operation-id: integer
-
Operation number
range:"1..2048"
- schedules: object
-
Schedule an operation
-
- schedule: object[]
-
Operation schedule configuration
-
object - ageout: integer
-
How long to keep this entry after it becomes inactive
range:"0..2073600" units:"second" - life: string
-
Length of the time to execute (default 3600 seconds)
- recurring: null
-
probe to be scheduled automatically every day
- start-time: object
-
Start time of the operation
-
- hour: integer
-
Hour value(hh) in hh:mm:ss specification
range:"0..23" - month: string january, february, march, april, may, june, july, august, september, october, november, december
-
Month of the year (optional. Default current month)
- second: integer
-
Second value(ss) in hh:mm:ss specification
range:"0..59" - schedule-type: string pending, now, after, at
-
Type of schedule
- year: integer
-
Year(optional. Default current year)
range:"1993..2035" - day: integer
-
Day of the month(optional. Default today)
range:"1..31" - minute: integer
-
Minute value(mm) in hh:mm:ss specification
range:"0..59"
- operation-id: integer
-
Operation number
range:"1..2048"
Example
{
"reaction-triggers": {
"reaction-trigger": [
{
"triggered-op-id": "integer",
"operation-id": "integer"
}
]
},
"reactions": {
"reaction": [
{
"condition": {
"timeout": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average-ds": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"rtt": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"packet-loss-ds": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average-sd": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"packet-loss-sd": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"jitter-average": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"verify-error": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
},
"connection-loss": {
"threshold-type": {
"thresh-type": "string",
"count1": "integer",
"count2": "integer"
}
}
},
"operation-id": "integer"
}
]
},
"definitions": {
"definition": [
{
"operation-type": {
"udp-echo": {
"data-size": {
"request": "integer"
},
"tag": "string"
},
"icmp-path-jitter": {
"data-size": {
"request": "integer"
},
"packet": {
"count": "integer",
"interval": "integer"
},
"tag": "string"
},
"udp-jitter": {
"data-size": {
"request": "integer"
},
"packet": {
"count": "integer",
"interval": "integer"
},
"tag": "string"
},
"icmp-echo": {
"tag": "string"
}
}
}
]
}
}
a1_threshold-limits_schema:
Specify threshold limits for the monitored element
- upper-limit: integer
-
Threshold upper limit value
range:"1..4294967295" - lower-limit: integer
-
Threshold lower limit value
range:"1..4294967295"
Example
{
"upper-limit": "integer",
"lower-limit": "integer"
}
a1_reaction-triggers_schema:
Reaction trigger configuration
- reaction-trigger: object[]
-
Reaction trigger for an operation
-
object - triggered-op-id: integer
-
Operation number of the operation to be triggered
range:"1..2048" - operation-id: integer
-
Operation number of the operation generating a trigger
range:"1..2048"
Example
{
"reaction-trigger": [
{
"triggered-op-id": "integer",
"operation-id": "integer"
}
]
}
a1_reaction-trigger_schema:
- triggered-op-id: integer
-
Operation number of the operation to be triggered
range:"1..2048" - operation-id: integer
-
Operation number of the operation generating a trigger
range:"1..2048"
Example
{
"triggered-op-id": "integer",
"operation-id": "integer"
}
a1_icmp-echo_schema:
ICMPEcho Operation type
- data-size: object
-
Protocol data size in payload of probe packets
-
- request: integer
-
Payload size in request probe packet
range:"0..16384" units:"byte" default:"100"
- source-address-v6: string
-
Enter IPv6 address of the source device
- dest-address-v6: string
-
Enter IPv6 address of the destination device
Example
{
"data-size": {
"request": "integer"
},
"source-address-v6": "string",
"dest-address-v6": "string",
"tag": "string"
}
a1_history_schema:
Configure the history parameters for this operation
- buckets: integer
-
Specify number of history buckets
range:"1..60" default:"15" - lives: integer
-
Specify number of lives to be kept
range:"0..2" default:"0" - history-filter: string failed, all
-
Choose type of data to be stored in history buffer
- samples: integer
-
Specify number of samples to keep
range:"1..30" default:"16"
Example
{
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
}
a1_enhanced-stats_schema:
Table of statistics collection intervals
- enhanced-stat: object[]
-
Statistics for a specified time interval
-
object - buckets: integer
-
Buckets of enhanced statistics kept
range:"1..60" default:"15" - interval: integer
-
Interval in seconds
units:"minute" default:"240"
Example
{
"enhanced-stat": [
{
"buckets": "integer",
"interval": "integer"
}
]
}
a1_enhanced-stat_schema:
- buckets: integer
-
Buckets of enhanced statistics kept
range:"1..60" default:"15" - interval: integer
-
Interval in seconds
units:"minute" default:"240"
Example
{
"buckets": "integer",
"interval": "integer"
}
a1_target_schema:
- target-addresses: object
-
SNMP Target address configurations
-
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
- target-list-name: string
-
Name of the target list
- vrf-names: object
-
List of VRF Name for a target list
-
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"target-addresses": {
"target-address": [
{
"ip-address": "string"
}
]
},
"target-list-name": "string",
"vrf-names": {
"vrf-name": [
{
"name": "string"
}
]
}
}
a1_traffic-engineering_schema:
Traffic engineering target
- tunnel: integer
-
Tunnel interface number
range:"0..65535"
Example
{
"tunnel": "integer"
}
a1_ipv4_schema:
SNMP TOS bit for outgoing packets
- tos: object
-
Type of TOS
-
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"tos": {
"type": "string",
"dscp": "string",
"precedence": "string"
}
}
a1_fec-address_schema:
Target FEC address with mask
- mask: string
-
IP netmask for target
- address: string
-
IP address for target
Example
{
"mask": "string",
"address": "string"
}
a1_pseudowire_schema:
Pseudowire target
- target-address: object
-
Target address
-
- vc-id: integer
-
Virtual circuit ID
range:"1..4294967295" - address: string
-
Target address
Example
{
"target-address": {
"vc-id": "integer",
"address": "string"
}
}
a1_udp-echo_schema:
UDPEcho Operation type
- data-size: object
-
Protocol data size in payload of probe packets
-
- request: integer
-
Payload size in request probe packet
range:"0..16384" units:"byte" default:"100"
Example
{
"data-size": {
"request": "integer"
},
"tag": "string"
}
a1_udp-jitter_schema:
UDPJitter Operation type
- data-size: object
-
Protocol data size in payload of probe packets
-
- request: integer
-
Payload size in request probe packet
range:"0..16384" units:"byte" default:"100"
- packet: object
-
Probe packet stream configuration parameters
-
- count: integer
-
Number of packets to be transmitted during a probe
range:"1..100" default:"10" - interval: integer
-
Packet interval in milliseconds
units:"minute" default:"240"
Example
{
"data-size": {
"request": "integer"
},
"packet": {
"count": "integer",
"interval": "integer"
},
"tag": "string"
}
a1_packet_schema:
Probe packet stream configuration parameters
- count: integer
-
Number of packets to be transmitted during a probe
range:"1..100" default:"10" - interval: integer
-
Packet interval in milliseconds
units:"minute" default:"240"
Example
{
"count": "integer",
"interval": "integer"
}
a1_icmp-path-echo_schema:
ICMPPathEcho Operation type
- statistics: object
-
Statistics collection aggregated over an hour
-
- dist-count: integer
-
Count of distribution intervals maintained
range:"1..20" default:"1" - paths: integer
-
Maximum number of paths for which statistics are kept
range:"1..128" default:"5" - hops: integer
-
Maximum hops per path for which statistics are kept
range:"1..30" default:"16" - hours: integer
-
Number of hours for which hourly statistics are kept
range:"0..25" units:"hour" default:"2" - dist-interval: integer
-
Specify distribution interval in milliseconds
range:"1..100" units:"millisecond" default:"20"
- data-size: object
-
Protocol data size in payload of probe packets
-
- request: integer
-
Payload size in request probe packet
range:"0..16384" units:"byte" default:"100"
- history: object
-
Configure the history parameters for this operation
-
- buckets: integer
-
Specify number of history buckets
range:"1..60" default:"15" - lives: integer
-
Specify number of lives to be kept
range:"0..2" default:"0" - history-filter: string failed, all
-
Choose type of data to be stored in history buffer
- samples: integer
-
Specify number of samples to keep
range:"1..30" default:"16"
Example
{
"statistics": {
"dist-count": "integer",
"paths": "integer",
"hops": "integer",
"hours": "integer",
"dist-interval": "integer"
},
"data-size": {
"request": "integer"
},
"history": {
"buckets": "integer",
"lives": "integer",
"history-filter": "string",
"samples": "integer"
},
"tag": "string"
}
a1_lsr-path_schema:
Loose source routing path (up to 8 intermediate nodes)
- node8: string
-
IPv4 address of the intermediate node
- node1: string
-
IPv4 address of the intermediate node
- node3: string
-
IPv4 address of the intermediate node
- node2: string
-
IPv4 address of the intermediate node
- node5: string
-
IPv4 address of the intermediate node
- node4: string
-
IPv4 address of the intermediate node
- node7: string
-
IPv4 address of the intermediate node
- node6: string
-
IPv4 address of the intermediate node
Example
{
"node8": "string",
"node1": "string",
"node3": "string",
"node2": "string",
"node5": "string",
"node4": "string",
"node7": "string",
"node6": "string"
}
a1_icmp-path-jitter_schema:
ICMPPathJitter Operation type
- data-size: object
-
Protocol data size in payload of probe packets
-
- request: integer
-
Payload size in request probe packet
range:"0..16384" units:"byte" default:"100"
- packet: object
-
Probe packet stream configuration parameters
-
- count: integer
-
Number of packets to be transmitted during a probe
range:"1..100" default:"10" - interval: integer
-
Packet interval in milliseconds
units:"minute" default:"240"
Example
{
"data-size": {
"request": "integer"
},
"packet": {
"count": "integer",
"interval": "integer"
},
"tag": "string"
}
a1_responder_schema:
Responder configuration
- twamp: object
-
Responder TWAMP configuration
-
- timeout: integer
-
Configure responder timeout value in seconds
range:"1..600000" units:"millisecond" default:"5000"
- type: object
-
Configure IPSLA Responder port type
-
- udp: object
-
Configure IPSLA Responder UDP address and port
-
- addresses: object
-
Configure IP address
-
- address: object[]
-
Configure IP address for the permanent port
-
object - local-address: string
-
IP address of the Responder
- ports: object
-
Configure port
-
- port: object[]
-
Configure port number for the permanent port
-
object - port: string
-
Port number to be enabled
Example
{
"twamp": {
"timeout": "integer"
},
"type": {
"udp": {
"addresses": {
"address": [
{
"local-address": "string",
"ports": {
"port": [
{
"port": "string"
}
]
}
}
]
}
}
}
}
a1_twamp_schema:
Responder TWAMP configuration
- timeout: integer
-
Configure responder timeout value in seconds
range:"1..600000" units:"millisecond" default:"5000"
Example
{
"timeout": "integer"
}
a1_type_schema:
Configure IPSLA Responder port type
- udp: object
-
Configure IPSLA Responder UDP address and port
-
- addresses: object
-
Configure IP address
-
- address: object[]
-
Configure IP address for the permanent port
-
object - local-address: string
-
IP address of the Responder
- ports: object
-
Configure port
-
- port: object[]
-
Configure port number for the permanent port
-
object - port: string
-
Port number to be enabled
Example
{
"udp": {
"addresses": {
"address": [
{
"local-address": "string",
"ports": {
"port": [
{
"port": "string"
}
]
}
}
]
}
}
}
a1_udp_schema:
Configure IPSLA Responder UDP address and port
- addresses: object
-
Configure IP address
-
- address: object[]
-
Configure IP address for the permanent port
-
object - local-address: string
-
IP address of the Responder
- ports: object
-
Configure port
-
- port: object[]
-
Configure port number for the permanent port
-
object - port: string
-
Port number to be enabled
Example
{
"addresses": {
"address": [
{
"local-address": "string",
"ports": {
"port": [
{
"port": "string"
}
]
}
}
]
}
}
a1_addresses_schema:
Configure IP address
- address: object[]
-
Configure IP address for the permanent port
-
object - local-address: string
-
IP address of the Responder
- ports: object
-
Configure port
-
- port: object[]
-
Configure port number for the permanent port
-
object - port: string
-
Port number to be enabled
Example
{
"address": [
{
"local-address": "string",
"ports": {
"port": [
{
"port": "string"
}
]
}
}
]
}
a1_address_schema:
- local-address: string
-
IP address of the Responder
- ports: object
-
Configure port
-
- port: object[]
-
Configure port number for the permanent port
-
object - port: string
-
Port number to be enabled
Example
{
"local-address": "string",
"ports": {
"port": [
{
"port": "string"
}
]
}
}
a1_ports_schema:
Configure port
- port: object[]
-
Configure port number for the permanent port
-
object - port: string
-
Port number to be enabled
Example
{
"port": [
{
"port": "string"
}
]
}
a1_mpls-discovery_schema:
Provider Edge(PE) discovery configuration
- vpn: object
-
Layer 3 VPN PE discovery configuration
-
- interval: integer
-
Specify a discovery refresh interval
units:"minute" default:"240"
Example
{
"vpn": {
"interval": "integer"
}
}
a1_vpn_schema:
Layer 3 VPN PE discovery configuration
- interval: integer
-
Specify a discovery refresh interval
units:"minute" default:"240"
Example
{
"interval": "integer"
}
a1_server-twamp_schema:
IPPM Server configuration
- inactivity-timer: integer
-
Configure ippmserver inactivity timer value in seconds
range:"1..6000" units:"second" default:"900" - port: string
-
Configure port number for ippmserver listening port
Example
{
"inactivity-timer": "integer",
"port": "string"
}
TRAP-HOST-TABLE:
Common node of snmp, vrf
- trap-hosts: object
-
Specify hosts to receive SNMP notifications
-
- trap-host: object[]
-
Specify hosts to receive SNMP notifications
-
object - encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"trap-hosts": {
"trap-host": [
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
}
APPLIED-TO:
Common node of rule, rule-set
- applied-to: object
-
Applied to the Rule or Ruleset
-
- all: null
-
Apply to all of the device
- hosts: object
-
Table of configured hosts to apply rules to
-
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
CONTEXT-MAPPING-TABLE:
Common node of snmp, vrf
- context-mappings: object
-
List of context names
-
- context-mapping: object[]
-
Context mapping name
-
object - context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
VAR-BIND-TABLE:
Common node of root-cause, non-root-cause
- var-binds: object
-
Varbinds to match
-
- var-bind: object[]
-
Varbind match conditions
-
object - oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
CONTEXT-TABLE:
Common node of snmp, vrf
- contexts: object
-
List of Context Names
-
- context: object[]
-
Context Name
-
object - context-name: string
-
Context Name
Example
{
"contexts": {
"context": [
{
"context-name": "string"
}
]
}
}
a1_snmp_schema:
SNMP notification configuration
- authentication: null
-
Enable authentication notification
- enable: null
-
Enable SNMP notifications
- warm-start: null
-
Enable warm start notification
- cold-start: null
-
Enable cold start notification
Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
a1_encrypted-community-maps_schema:
Container class to hold clear/encrypted communitie maps
- encrypted-community-map: object[]
-
Clear/encrypted SNMP community map
-
object - security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"encrypted-community-map": [
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
]
}
a1_encrypted-community-map_schema:
- security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
a1_views_schema:
Class to configure a SNMPv2 MIB view
- view: object[]
-
Name of the view
-
object - view-name: string
-
Name of the view
- view-inclusion: string included, excluded
-
MIB view to be included or excluded
- family: string
-
MIB view family name
Example
{
"view": [
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
]
}
a1_view_schema:
- view-name: string
-
Name of the view
- view-inclusion: string included, excluded
-
MIB view to be included or excluded
- family: string
-
MIB view family name
Example
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
a1_logging_schema:
SNMP logging
- threshold: object
-
SNMP logging threshold
-
- oid-processing: integer
-
SNMP logging threshold for OID processing
range:"0..20000" default:"500" - pdu-processing: integer
-
SNMP logging threshold for PDU processing
range:"0..20000" default:"20000"
Example
{
"threshold": {
"oid-processing": "integer",
"pdu-processing": "integer"
}
}
a1_threshold_schema:
SNMP logging threshold
- oid-processing: integer
-
SNMP logging threshold for OID processing
range:"0..20000" default:"500" - pdu-processing: integer
-
SNMP logging threshold for PDU processing
range:"0..20000" default:"20000"
Example
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
a1_administration_schema:
Container class for SNMP administration
- default-communities: object
-
Container class to hold unencrpted communities
-
- default-community: object[]
-
Unencrpted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- encrypted-communities: object
-
Container class to hold clear/encrypted communities
-
- encrypted-community: object[]
-
Clear/encrypted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"default-communities": {
"default-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
},
"encrypted-communities": {
"encrypted-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
a1_default-communities_schema:
Container class to hold unencrpted communities
- default-community: object[]
-
Unencrpted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"default-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
a1_default-community_schema:
- priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
a1_encrypted-communities_schema:
Container class to hold clear/encrypted communities
- encrypted-community: object[]
-
Clear/encrypted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"encrypted-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
a1_encrypted-community_schema:
- priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
a1_agent_schema:
The heirarchy point for SNMP Agent configurations
- engine-id: object
-
SNMPv3 engineID
-
- remotes: object
-
SNMPv3 remote SNMP Entity
-
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- local: string
-
engineID of the local agent
Example
{
"engine-id": {
"remotes": {
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
},
"local": "string"
}
}
a1_engine-id_schema:
SNMPv3 engineID
- remotes: object
-
SNMPv3 remote SNMP Entity
-
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- local: string
-
engineID of the local agent
Example
{
"remotes": {
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
},
"local": "string"
}
a1_remotes_schema:
SNMPv3 remote SNMP Entity
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
Example
{
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
}
a1_remote_schema:
- remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
Example
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
a1_trap_schema:
Class to hold trap configurations
- queue-length: integer
-
Message queue length for each TRAP host
range:"1..5000" - throttle-time: integer
-
Set throttle time for handling traps
range:"50..1000" units:"millisecond" - timeout: integer
-
Timeout for TRAP message retransmissions
range:"1..600000" units:"millisecond" default:"5000"
Example
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
a1_drop-packet_schema:
SNMP packet drop config
- unknown-user: null
-
Enable drop unknown user name
Example
{
"unknown-user": [ null ]
}
a1_ipv6_schema:
SNMP TOS bit for outgoing packets
- tos: object
-
Type of TOS
-
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"tos": {
"type": "string",
"dscp": "string",
"precedence": "string"
}
}
a1_tos_schema:
Type of TOS
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
a1_system_schema:
container to hold system information
- chassis-id: string
-
String to uniquely identify this chassis
- contact: string
-
identification of the contact person for this managed node
- location: string
-
The physical location of this node
Example
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
a1_targets_schema:
List of targets
- target: object[]
-
Name of the target list
-
object - target-addresses: object
-
SNMP Target address configurations
-
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
- target-list-name: string
-
Name of the target list
- vrf-names: object
-
List of VRF Name for a target list
-
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"target": [
{
"target-addresses": {
"target-address": [
{
"ip-address": "string"
}
]
},
"target-list-name": "string",
"vrf-names": {
"vrf-name": [
{
"name": "string"
}
]
}
}
]
}
a1_vrf-names_schema:
List of VRF Name for a target list
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"vrf-name": [
{
"name": "string"
}
]
}
a1_target-addresses_schema:
SNMP Target address configurations
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
Example
{
"target-address": [
{
"ip-address": "string"
}
]
}
a1_notification_schema:
Enable SNMP notifications
- ipsla: boolean
-
Enable SNMP RTTMON-MIB IPSLA traps
- snmp: object
-
SNMP notification configuration
-
- authentication: null
-
Enable authentication notification
- enable: null
-
Enable SNMP notifications
- warm-start: null
-
Enable warm start notification
- cold-start: null
-
Enable cold start notification
Example
{
"ipsla": "boolean",
"snmp": {
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
}
a1_correlator_schema:
Configure properties of the trap correlator
- rules: object
-
Table of configured rules
-
- rule: object[]
-
Rule name
-
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" default:"5000" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
- rule-sets: object
-
Table of configured rulesets
-
- rule-set: object[]
-
Ruleset name
-
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
- buffer-size: integer
-
Configure size of the correlator buffer
range:"1024..2147483647" units:"byte"
Example
{
"rules": {
"rule": [
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"rule-sets": {
"rule-set": [
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
a1_rules_schema:
Table of configured rules
- rule: object[]
-
Rule name
-
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" default:"5000" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
Example
{
"rule": [
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
a1_rule_schema:
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" default:"5000" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
Example
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
a1_root-causes_schema:
Table of configured rootcause (only one entry allowed)
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
Example
{
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
}
a1_root-cause_schema:
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
Example
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
a1_var-binds_schema:
Varbinds to match
- var-bind: object[]
-
Varbind match conditions
-
object - oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
a1_var-bind_schema:
- oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
a1_match_schema:
VarBind match conditions
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"index": "string",
"value": "string"
}
a1_non-root-causes_schema:
Table of configured non-rootcause
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
Example
{
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
}
a1_non-root-cause_schema:
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
Example
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
a1_applied-to_schema:
Applied to the Rule or Ruleset
- all: null
-
Apply to all of the device
- hosts: object
-
Table of configured hosts to apply rules to
-
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
a1_hosts_schema:
Table of configured hosts to apply rules to
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
a1_host_schema:
- port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"port": "string",
"ip-address": "string"
}
a1_rule-sets_schema:
Table of configured rulesets
- rule-set: object[]
-
Ruleset name
-
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"rule-set": [
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
a1_rule-set_schema:
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
a1_rulenames_schema:
Table of configured rulenames
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"rulename": [
{
"rulename": "string"
}
]
}
a1_bulk-stats_schema:
SNMP bulk stats configuration commands
- memory: integer
-
per process memory limit in kilo bytes
range:"100..200000" units:"kilobyte" - transfers: object
-
Periodicity for the transfer of bulk data in minutes
-
- transfer: object[]
-
Name of bulk transfer
-
object - retry: integer
-
Number of transmission retries
range:"0..100" default:"1" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"minute" default:"240" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
- objects: object
-
Configure an Object List
-
- object: object[]
-
Name of the object List
-
object - object-list-name: string
-
Name of the object List
- objects: object
-
Configure an object List
-
- object: object[]
-
Object name or OID
-
object - oid: string
-
Object name or OID
- type: null
-
Configure object list name
- schemas: object
-
Configure schema definition
-
- schema: object[]
-
The name of the Schema
-
object - schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"memory": "integer",
"transfers": {
"transfer": [
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
},
"objects": {
"object": [
{
"object-list-name": "string",
"objects": {
"object": [
{
"oid": "string"
}
]
},
"type": [ null ]
}
]
},
"schemas": {
"schema": [
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
a1_schemas_schema:
Configure schema definition
- schema: object[]
-
The name of the Schema
-
object - schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"schema": [
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
a1_schema_schema:
- schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
a1_instance_schema:
Object instance information
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
Example
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
a1_objects_schema:
Configure an object List
- object: object[]
-
Object name or OID
-
object - oid: string
-
Object name or OID
Example
{
"object": [
{
"oid": "string"
}
]
}
a1_transfers_schema:
Periodicity for the transfer of bulk data in minutes
- transfer: object[]
-
Name of bulk transfer
-
object - retry: integer
-
Number of transmission retries
range:"0..100" default:"1" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"minute" default:"240" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
Example
{
"transfer": [
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
a1_transfer_schema:
- retry: integer
-
Number of transmission retries
range:"0..100" default:"1" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"minute" default:"240" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
Example
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
a1_transfer-schemas_schema:
Schema that contains objects to be collected
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
Example
{
"transfer-schema": [
{
"schema-name": "string"
}
]
}
a1_transfer-schema_schema:
- schema-name: string
-
Schema that contains objects to be collected
Example
{
"schema-name": "string"
}
a1_default-community-maps_schema:
Container class to hold unencrpted community map
- default-community-map: object[]
-
Unencrpted SNMP community map name
-
object - security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"default-community-map": [
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
]
}
a1_default-community-map_schema:
- security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
a1_overload-control_schema:
Set overload control params for handling incoming messages
- drop-time: integer
-
Drop time in seconds for incoming queue (default 1 sec)
range:"0..300" units:"second" - throttle-rate: integer
-
Throttle time in milliseconds for incoming queue (default 500 msec)
range:"0..1000" units:"millisecond"
Example
{
"drop-time": "integer",
"throttle-rate": "integer"
}
a1_timeouts_schema:
SNMP timeouts
- duplicates: integer
-
Duplicate request feature timeout
range:"0..20" units:"second" default:"1" - threshold: integer
-
Threshold request feature timeout
range:"0..100000" units:"second" default:"50000" - pdu-stats: integer
-
SNMP pdu statistics timeout
range:"1..10" units:"second" default:"2" - in-qdrop: integer
-
incoming queue drop feature timeout
range:"0..20" units:"second" default:"10" - subagent: integer
-
Sub-Agent Request timeout
range:"1..20" units:"second" default:"10"
Example
{
"duplicates": "integer",
"threshold": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
a1_users_schema:
Define a user who can access the SNMP engine
- user: object[]
-
Name of the user
-
object - v6acl-type: string ipv4, ipv6
-
Access-list type
- group-name: string
-
Group to which the user belongs
- v6-access-list: string
-
Ipv6 Access-list name
- priv-algorithm: string none, des, 3des, aes128, aes192, aes256
-
The algorithm used des56 or aes128 or aes192or aes256 or 3des
- owner: string sdr-owner, system-owner
-
The system access either SDROwner or SystemOwner
- v4acl-type: string ipv4, ipv6
-
Access-list type
- privacy-password: string
-
The privacy password
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- user-name: string
-
Name of the user
- algorithm: string none, md5, sha
-
The algorithm used md5 or sha
- privacy-password-configured: null
-
Flag to indicate that the privacy password is configured for version 3
- authentication-password: string
-
The authentication password
- version: string v1, v2c, v3
-
SNMP version to be used. v1,v2c or v3
- v4-access-list: string
-
Ipv4 Access-list name
- authentication-password-configured: null
-
Flag to indicate that authentication password is configred for version 3
Example
{
"user": [
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
a1_user_schema:
- v6acl-type: string ipv4, ipv6
-
Access-list type
- group-name: string
-
Group to which the user belongs
- v6-access-list: string
-
Ipv6 Access-list name
- priv-algorithm: string none, des, 3des, aes128, aes192, aes256
-
The algorithm used des56 or aes128 or aes192or aes256 or 3des
- owner: string sdr-owner, system-owner
-
The system access either SDROwner or SystemOwner
- v4acl-type: string ipv4, ipv6
-
Access-list type
- privacy-password: string
-
The privacy password
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- user-name: string
-
Name of the user
- algorithm: string none, md5, sha
-
The algorithm used md5 or sha
- privacy-password-configured: null
-
Flag to indicate that the privacy password is configured for version 3
- authentication-password: string
-
The authentication password
- version: string v1, v2c, v3
-
SNMP version to be used. v1,v2c or v3
- v4-access-list: string
-
Ipv4 Access-list name
- authentication-password-configured: null
-
Flag to indicate that authentication password is configred for version 3
Example
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
a1_vrfs_schema:
SNMP VRF configuration commands
- vrf: object[]
-
VRF name
-
- name: string
-
VRF name
Example
{
"vrf": [
{
"name": "string",
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
]
}
a1_vrf_schema:
- name: string
-
VRF name
Example
{
"name": "string",
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
a1_trap-hosts_schema:
Specify hosts to receive SNMP notifications
- trap-host: object[]
-
Specify hosts to receive SNMP notifications
-
object - encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"trap-host": [
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
a1_trap-host_schema:
- encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
a1_encrypted-user-communities_schema:
Container class for defining Clear/encrypt communities for a trap host
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a1_encrypted-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a1_inform-host_schema:
Container class for defining notification type for a Inform host
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
a1_inform-user-communities_schema:
Container class for defining communities for a inform host
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a1_inform-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a1_inform-encrypted-user-communities_schema:
Container class for defining Clear/encrypt communities for a inform host
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a1_inform-encrypted-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a1_default-user-communities_schema:
Container class for defining communities for a trap host
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a1_default-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a1_contexts_schema:
List of Context Names
- context: object[]
-
Context Name
-
object - context-name: string
-
Context Name
Example
{
"context": [
{
"context-name": "string"
}
]
}
a1_context-mappings_schema:
List of context names
- context-mapping: object[]
-
Context mapping name
-
object - context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
a1_context-mapping_schema:
- context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
a1_groups_schema:
Define a User Security Model group
- group: object[]
-
Name of the group
-
object - name: string
-
Name of the group
- write-view: string
-
write view name
- snmp-version: string v1, v2c, v3
-
snmp version
- context-name: string
-
Context name
- security-model: string no-authentication, authentication, privacy
-
security model like auth/noAuth/Priv applicable for v3
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- read-view: string
-
read view name
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- notify-view: string
-
notify view name
Example
{
"group": [
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
a1_group_schema:
- name: string
-
Name of the group
- write-view: string
-
write view name
- snmp-version: string v1, v2c, v3
-
snmp version
- context-name: string
-
Context name
- security-model: string no-authentication, authentication, privacy
-
security model like auth/noAuth/Priv applicable for v3
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- read-view: string
-
read view name
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- notify-view: string
-
notify view name
Example
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}